#include <TransportControlElement.h>

Inheritance diagram for OpenDDS::DCPS::TransportControlElement:

Collaboration diagram for OpenDDS::DCPS::TransportControlElement:

[legend]

Public Member Functions
	TransportControlElement (Message_Block_Ptr msg_block, const GUID_t &publication_id=GUID_UNKNOWN)

virtual	~TransportControlElement ()

virtual bool	owned_by_transport ()
	Is the sample created by the transport? More...

Public Member Functions inherited from OpenDDS::DCPS::TransportQueueElement
virtual	~TransportQueueElement ()

bool	data_dropped (bool dropped_by_transport=false)

bool	data_delivered ()

void	increment_loan ()

virtual GUID_t	subscription_id () const
	Accessor for the subscription id, if sent the sample is sent to 1 sub. More...

virtual SequenceNumber	sequence () const

virtual bool	is_control (GUID_t pub_id) const
	Is the element a "control" sample from the specified pub_id? More...

bool	released () const
	Is the listener get called ? More...

void	released (bool flag)

virtual TqePair	fragment (size_t size)

virtual bool	is_fragment () const
	Is this QueueElement the result of fragmentation? More...

virtual bool	is_last_fragment () const
	Is this QueueElement the last result of fragmentation? More...

virtual bool	is_request_ack () const

virtual bool	is_retained_replaced () const

Protected Member Functions
virtual bool	requires_exclusive_packet () const
	Does the sample require an exclusive transport packet? More...

virtual GUID_t	publication_id () const
	Accessor for the publication id that sent the sample. More...

virtual ACE_Message_Block *	duplicate_msg () const
	A reference-incremented duplicate of the marshalled sample (sample header + sample data) More...

virtual const ACE_Message_Block *	msg () const
	The marshalled sample (sample header + sample data) More...

virtual const ACE_Message_Block *	msg_payload () const
	The marshalled payload only (sample data) More...

virtual void	release_element (bool dropped_by_transport)
	Invoked when the counter reaches 0. More...

virtual void	data_delivered ()

Protected Member Functions inherited from OpenDDS::DCPS::TransportQueueElement
	TransportQueueElement (unsigned long initial_count)

bool	was_dropped () const

Private Member Functions
	TransportControlElement (const TransportControlElement &)

Private Attributes
Message_Block_Ptr	msg_
	The control message. More...

GUID_t	publication_id_

Additional Inherited Members
Static Public Member Functions inherited from OpenDDS::DCPS::TransportQueueElement
static ACE_Message_Block *	clone_mb (const ACE_Message_Block msg, MessageBlockAllocator mb_allocator, DataBlockAllocator *db_allocator)

Detailed Description

Definition at line 26 of file TransportControlElement.h.

Constructor & Destructor Documentation

◆ TransportControlElement() [1/2]

OpenDDS::DCPS::TransportControlElement::TransportControlElement	(	Message_Block_Ptr	msg_block,
		const GUID_t &	publication_id = `GUID_UNKNOWN`
	)

explicit

msg_block - chain of ACE_Message_Blocks containing the control sample held by this queue element, if any.

Definition at line 16 of file TransportControlElement.cpp.

References DBG_ENTRY_LVL, and release().

   : TransportQueueElement(1)
   , msg_( msg_block.release())
   , publication_id_(publication_id)
 {
   DBG_ENTRY_LVL("TransportControlElement", "TransportControlElement", 6);
 }

◆ ~TransportControlElement()

OpenDDS::DCPS::TransportControlElement::~TransportControlElement ( )

virtual

Definition at line 25 of file TransportControlElement.cpp.

References DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("TransportControlElement", "~TransportControlElement", 6);
 }

◆ TransportControlElement() [2/2]

OpenDDS::DCPS::TransportControlElement::TransportControlElement ( const TransportControlElement & )

private

Member Function Documentation

◆ data_delivered()

ACE_INLINE void OpenDDS::DCPS::TransportControlElement::data_delivered ( )

protectedvirtual

Definition at line 20 of file TransportControlElement.inl.

References ACE_INLINE, and DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("TransportControlElement", "data_delivered", 6);
 }

◆ duplicate_msg()

ACE_INLINE ACE_Message_Block * OpenDDS::DCPS::TransportControlElement::duplicate_msg ( ) const

protectedvirtual

A reference-incremented duplicate of the marshalled sample (sample header + sample data)

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 34 of file TransportControlElement.inl.

References ACE_INLINE, ACE_Message_Block::duplicate(), and msg_.

 {
   return msg_->duplicate();
 }

◆ msg()

ACE_INLINE const ACE_Message_Block * OpenDDS::DCPS::TransportControlElement::msg ( ) const

protectedvirtual

The marshalled sample (sample header + sample data)

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 41 of file TransportControlElement.inl.

References ACE_INLINE, OpenDDS::DCPS::unique_ptr< T, Deleter >::get(), and msg_.

 {
   return msg_.get();
 }

◆ msg_payload()

ACE_INLINE const ACE_Message_Block * OpenDDS::DCPS::TransportControlElement::msg_payload ( ) const

protectedvirtual

The marshalled payload only (sample data)

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 48 of file TransportControlElement.inl.

References ACE_INLINE, ACE_Message_Block::cont(), and msg_.

 {
   return msg_->cont();
 }

◆ owned_by_transport()

ACE_INLINE bool OpenDDS::DCPS::TransportControlElement::owned_by_transport ( )

virtual

Is the sample created by the transport?

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 55 of file TransportControlElement.inl.

 {
   return true;
 }

◆ publication_id()

ACE_INLINE OpenDDS::DCPS::GUID_t OpenDDS::DCPS::TransportControlElement::publication_id ( ) const

protectedvirtual

Accessor for the publication id that sent the sample.

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 27 of file TransportControlElement.inl.

References ACE_INLINE, and publication_id_.

 {
   return publication_id_;
 }

◆ release_element()

void OpenDDS::DCPS::TransportControlElement::release_element ( bool dropped_by_transport )

protectedvirtual

Invoked when the counter reaches 0.

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 31 of file TransportControlElement.cpp.

 {
   delete this;
 }

◆ requires_exclusive_packet()

ACE_INLINE bool OpenDDS::DCPS::TransportControlElement::requires_exclusive_packet ( ) const

protectedvirtual

Does the sample require an exclusive transport packet?

Reimplemented from OpenDDS::DCPS::TransportQueueElement.

Definition at line 12 of file TransportControlElement.inl.

References ACE_INLINE, and DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("TransportControlElement", "requires_exclusive_packet", 6);
   return true;
 }

Member Data Documentation

◆ msg_

Message_Block_Ptr OpenDDS::DCPS::TransportControlElement::msg_

private

The control message.

Definition at line 60 of file TransportControlElement.h.

Referenced by duplicate_msg(), msg(), and msg_payload().

◆ publication_id_

GUID_t OpenDDS::DCPS::TransportControlElement::publication_id_

private

Definition at line 61 of file TransportControlElement.h.

Referenced by publication_id().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TransportControlElement() [1/2]

◆ ~TransportControlElement()

◆ TransportControlElement() [2/2]

Member Function Documentation

◆ data_delivered()

◆ duplicate_msg()

◆ msg()

◆ msg_payload()

◆ owned_by_transport()

◆ publication_id()

◆ release_element()

◆ requires_exclusive_packet()

Member Data Documentation

◆ msg_

◆ publication_id_