dw::framework::IChannelPacket::SocketCallbacks Class Reference

Detailed Description

Additional interfaces needed by socket channels to allocate and transport the data type. A packet transported by socket must have the ability to be serialized to and deserialized from a private buffer.

Definition at line 72 of file IChannelPacket.hpp.

Inheritance diagram for dw::framework::IChannelPacket::SocketCallbacks:

Public Member Functions
virtual void	deserialize (size_t)=0
virtual uint8_t *	getBuffer ()=0
virtual size_t	getBufferSize ()=0
virtual size_t	serialize ()=0

Member Function Documentation

deserialize()

virtual void dw::framework::IChannelPacket::SocketCallbacks::deserialize ( size_t  )

pure virtual

Deserialize the packet contents from the payload.

Implemented in dw::framework::ChannelPacketDefault, and dw::framework::ChannelSocketPacketBase.

getBuffer()

virtual uint8_t * dw::framework::IChannelPacket::SocketCallbacks::getBuffer ( )

pure virtual

Get a pointer to the serialized payload.

Implemented in dw::framework::ChannelPacketDefault, and dw::framework::ChannelSocketPacketBase.

getBufferSize()

virtual size_t dw::framework::IChannelPacket::SocketCallbacks::getBufferSize ( )

pure virtual

Get the maximum size of the serialized payload.

Returns

size_t

Implemented in dw::framework::ChannelPacketDefault, and dw::framework::ChannelSocketPacketBase.

serialize()

virtual size_t dw::framework::IChannelPacket::SocketCallbacks::serialize ( )

pure virtual

Serialize the packet contents to the payload.

Returns

size_t the size of the serialized payload

Implemented in dw::framework::ChannelPacketDefault, and dw::framework::ChannelSocketPacketBase.

---

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

• src/dwcgf/channel/IChannelPacket.hpp