DtCommentPdu Class Reference

Instances of DtCommentPdu are used to send/receive comment PDUs. More...

Inheritance diagram for DtCommentPdu:

Collaboration diagram for DtCommentPdu:

List of all members.

Public Types
enum	{ PduStaticSize = 32 }
Public Member Functions
	DtCommentPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtCommentPdu (const DtNetCommentPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtCommentPdu (const DtEntityIdentifier &sender, const DtEntityIdentifier &receiver, const char *message, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual void	setComment (const char *message, int size)
	Set the comment.
virtual const char *	comment () const
Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtCommentPdu.
static void	addCallback (DtExerciseConn *conn, DtCommentPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtCommentPduCb cb, void *usr)
Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
DtNetDataPduTail *	dataSection () const
	Returns the data portion of the pdu.

---

Detailed Description

Instances of DtCommentPdu are used to send/receive comment PDUs.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

---

Constructor & Destructor Documentation

DtCommentPdu::DtCommentPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtCommentPdu::DtCommentPdu	(	const DtNetCommentPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtCommentPdu::DtCommentPdu	(	const DtEntityIdentifier &	sender,
		const DtEntityIdentifier &	receiver,
		const char *	message,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

---

Member Function Documentation

static void DtCommentPdu::addCallback	(	DtExerciseConn *	conn,
		DtCommentPduCb	cb,
		void *	usr
	)		[static]

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual const char* DtCommentPdu::comment

(

)

const [virtual]

static DtPdu* DtCommentPdu::create	(	const DtNetPacket *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)		[static]

Create a DtCommentPdu.

Caller is responsible for deletion.

DtNetDataPduTail* DtCommentPdu::dataSection

(

)

const [protected, virtual]

Returns the data portion of the pdu.

Implements DtPduWithData.

DtPduKind DtCommentPdu::internalGetPduKind

(

)

const [inline, protected, virtual]

Returns the internal PDU kind.

Implements DtPdu.

References DtCommentPduKind.

static void DtCommentPdu::removeCallback	(	DtExerciseConn *	conn,
		DtCommentPduCb	cb,
		void *	usr
	)		[static]

virtual void DtCommentPdu::setComment	(	const char *	message,
		int	size
	)		[virtual]

Set the comment.

Comments are sent in the first variable length message record.

---

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

• commentPdu.h