MidAndDataReplyObject Class Reference

Reply object that checks the message identifier and data in the data field. More...

#include <replyobject.h>

Inheritance diagram for MidAndDataReplyObject:

Public Member Functions
virtual bool	isReplyFor (XsMessage const &message)
	MidAndDataReplyObject (uint8_t messageId, XsSize offset, XsSize size, uint8_t const *data)
	MidAndDataReplyObject constructor. More...
virtual uint8_t	msgId () const
void	setData (uint8_t const *data)
	Copies data from 'data' into this object. This is the data to wait for. More...
	~MidAndDataReplyObject ()
	MidAndDataReplyObject destructor. More...
Public Member Functions inherited from ReplyObject
XsMessage	message (uint32_t timeout)
	Blocks until a message has been set by setMessage() then returns that message. More...
	ReplyObject ()
	Default constructor. More...
void	setMessage (const XsMessage &msg)
	Sets a message as reply message and trigger the semaphore which will unblock any waiting message() calls. More...
virtual	~ReplyObject ()

Private Member Functions
void	freeData ()
	Frees allocated data (if any) More...

Private Attributes
uint8_t *	m_data
XsSize	m_dataOffset
XsSize	m_dataSize
uint8_t	m_messageId

Detailed Description

Reply object that checks the message identifier and data in the data field.

Definition at line 123 of file replyobject.h.

Constructor & Destructor Documentation

MidAndDataReplyObject()

MidAndDataReplyObject::MidAndDataReplyObject	(	uint8_t	messageId,
		XsSize	offset,
		XsSize	size,
		uint8_t const *	data
	)

MidAndDataReplyObject constructor.

Parameters

[in]	messageId	the message id of the message to wait for
[in]	offset	the offset in the data part of the message
[in]	size	the size of the data in the data part of the message
[in]	data	pointer to data to wait for (this object does not take ownership of the data)

Definition at line 161 of file replyobject.cpp.

~MidAndDataReplyObject()

MidAndDataReplyObject::~MidAndDataReplyObject

(

)

MidAndDataReplyObject destructor.

Definition at line 174 of file replyobject.cpp.

Member Function Documentation

freeData()

void MidAndDataReplyObject::freeData ( )

private

Frees allocated data (if any)

Definition at line 207 of file replyobject.cpp.

isReplyFor()

bool MidAndDataReplyObject::isReplyFor ( XsMessage const &  msg )

virtual

Returns

true when a message is a valid reply message for this reply object

Parameters

[in]

msg

the message to check

Implements ReplyObject.

Definition at line 196 of file replyobject.cpp.

msgId()

uint8_t MidAndDataReplyObject::msgId ( ) const

virtual

Returns

the message ID that this reply object is waiting for

Implements ReplyObject.

Definition at line 188 of file replyobject.cpp.

setData()

void MidAndDataReplyObject::setData

(

uint8_t const *

data

)

Copies data from 'data' into this object. This is the data to wait for.

Parameters

[in]

data

the data to copy into this object and wait for

Definition at line 219 of file replyobject.cpp.

Member Data Documentation

m_data

uint8_t* MidAndDataReplyObject::m_data

private

Definition at line 136 of file replyobject.h.

m_dataOffset

XsSize MidAndDataReplyObject::m_dataOffset

private

Definition at line 134 of file replyobject.h.

m_dataSize

XsSize MidAndDataReplyObject::m_dataSize

private

Definition at line 135 of file replyobject.h.

m_messageId

uint8_t MidAndDataReplyObject::m_messageId

private

Definition at line 133 of file replyobject.h.

---

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

• replyobject.h
• replyobject.cpp