---

SmartSockets::TipcMsgTraverser Class Reference

#include <rtworks/tmsg.h>

List of all members.

Public Types
typedef bool(TipcMsgTraverser::*	Handler )(const TipcMsg &msg, T_IPC_FT type, bool isUnknown, void *valuePtr, int4 size, T_IPC_MSG_FIELD field, int4 index, const char *name)
Public Methods
	TipcMsgTraverser ()
void	setHandler (Handler cbMethod)
Handler	getHandler ()
virtual	~TipcMsgTraverser () throw ()
virtual bool	onTraverse (const TipcMsg &msg, T_IPC_FT type, bool isUnknown, void *valuePtr, int4 size, T_IPC_MSG_FIELD field, int4 index, const char *name) throw ()
Static Public Methods
T_PTR T_ENTRY	traverseFuncDelegator (T_IPC_MSG msg, T_IPC_MSG_TRAV trav, T_PTR arg)

---

Detailed Description

Traverser class to be used by TipcMsg::traverse().

---

Member Typedef Documentation

typedef bool(TipcMsgTraverser::* SmartSockets::TipcMsgTraverser::Handler)( const TipcMsg& msg, T_IPC_FT type, bool isUnknown, void* valuePtr, int4 size, T_IPC_MSG_FIELD field, int4 index, const char* name )

Signature for the traverse method. Parameters: msg  the message to which the fields belong. type  the field type. flag  to determine whether or not a message field is unknown valuePtr  void pointer to the current field value; this may be cast to the appropriate value. size  number of elements of array fields or number of bytes of binary fields. field  that can be updated by using one of the TipcMsg::updatePtr() methods. index  zero-based position of the current field. name  of the field; NULL if not a named field. Returns: true to continue traversing; false otherwise.

---

Constructor & Destructor Documentation

virtual SmartSockets::TipcMsgTraverser::~TipcMsgTraverser (    )  throw () [virtual]

Destructor.

---

Member Function Documentation

Handler SmartSockets::TipcMsgTraverser::getHandler (    )

Gets the current handler method.

virtual bool SmartSockets::TipcMsgTraverser::onTraverse (  const TipcMsg &    msg, T_IPC_FT    type, bool    isUnknown, void *    valuePtr, int4    size, T_IPC_MSG_FIELD    field, int4    index, const char *    name )  throw () [virtual]

Default traverse method. Parameters: msg  the message to which the fields belong. type  the field type. flag  to determine whether or not a message field is unknown valuePtr  void pointer to the current field value; this may be cast to the appropriate value. size  number of elements of array fields or number of bytes of binary fields. field  that can be updated by using one of the TipcMsg::updatePtr() methods. index  zero-based position of the current field. name  of the field; NULL if not a named field. Returns: true to continue traversing; false otherwise.

void SmartSockets::TipcMsgTraverser::setHandler (  Handler    cbMethod )

Sets the current handler method; if this is not called, the default method onTraverse() is called.

---

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

• tmsg.h

---