OpenDDS::DCPS::TransportControlElement Class Reference

#include <TransportControlElement.h>

Inheritance diagram for OpenDDS::DCPS::TransportControlElement:

[legend]

Collaboration diagram for OpenDDS::DCPS::TransportControlElement:

[legend]

List of all members.

Public Member Functions
	TransportControlElement (Message_Block_Ptr msg_block)
virtual	~TransportControlElement ()
virtual bool	owned_by_transport ()
	Is the sample created by the transport?
Protected Member Functions
virtual bool	requires_exclusive_packet () const
	Does the sample require an exclusive transport packet?
virtual RepoId	publication_id () const
	Accessor for the publication id that sent the sample.
virtual const ACE_Message_Block *	msg () const
	The marshalled sample (sample header + sample data).
virtual const ACE_Message_Block *	msg_payload () const
	The marshalled payload only (sample data).
virtual void	release_element (bool dropped_by_transport)
	Invoked when the counter reaches 0.
virtual void	data_delivered ()
Private Member Functions
	TransportControlElement (const TransportControlElement &)
Private Attributes
Message_Block_Ptr	msg_
	The control message.

---

Detailed Description

Definition at line 26 of file TransportControlElement.h.

---

Constructor & Destructor Documentation

OpenDDS::DCPS::TransportControlElement::TransportControlElement

(

Message_Block_Ptr

msg_block

)

[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())
{
  DBG_ENTRY_LVL("TransportControlElement","TransportControlElement",6);
}

Here is the call graph for this function:

OpenDDS::DCPS::TransportControlElement::~TransportControlElement

(

)

[virtual]

Definition at line 24 of file TransportControlElement.cpp.

References DBG_ENTRY_LVL.

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

OpenDDS::DCPS::TransportControlElement::TransportControlElement

(

const TransportControlElement &

)

[private]

---

Member Function Documentation

ACE_INLINE void OpenDDS::DCPS::TransportControlElement::data_delivered

(

)

[protected, virtual]

Invoked when the sample has been sent by a DataLink. The return value indicates if this element is released.

Reimplemented from OpenDDS::DCPS::TransportQueueElement.

Definition at line 20 of file TransportControlElement.inl.

References DBG_ENTRY_LVL.

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

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

(

)

const [protected, virtual]

The marshalled sample (sample header + sample data).

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 34 of file TransportControlElement.inl.

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

{
  return this->msg_.get();
}

Here is the call graph for this function:

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

(

)

const [protected, virtual]

The marshalled payload only (sample data).

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 41 of file TransportControlElement.inl.

References msg_.

{
  return this->msg_->cont();
}

ACE_INLINE bool OpenDDS::DCPS::TransportControlElement::owned_by_transport

(

)

[virtual]

Is the sample created by the transport?

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 48 of file TransportControlElement.inl.

{
  return true;
}

ACE_INLINE OpenDDS::DCPS::RepoId OpenDDS::DCPS::TransportControlElement::publication_id

(

)

const [protected, virtual]

Accessor for the publication id that sent the sample.

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 27 of file TransportControlElement.inl.

References OpenDDS::DCPS::GUID_UNKNOWN.

{
  return GUID_UNKNOWN;
}

void OpenDDS::DCPS::TransportControlElement::release_element

(

bool

dropped_by_transport

)

[protected, virtual]

Invoked when the counter reaches 0.

Implements OpenDDS::DCPS::TransportQueueElement.

Definition at line 30 of file TransportControlElement.cpp.

{
  delete this;
}

ACE_INLINE bool OpenDDS::DCPS::TransportControlElement::requires_exclusive_packet

(

)

const [protected, virtual]

Does the sample require an exclusive transport packet?

Reimplemented from OpenDDS::DCPS::TransportQueueElement.

Definition at line 12 of file TransportControlElement.inl.

References DBG_ENTRY_LVL.

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

---

Member Data Documentation

Message_Block_Ptr OpenDDS::DCPS::TransportControlElement::msg_ [private]

The control message.

Definition at line 57 of file TransportControlElement.h.

Referenced by msg(), and msg_payload().

---

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

• TransportControlElement.h
• TransportControlElement.cpp
• TransportControlElement.inl