Objects implementing this interface have the capability to convert data sources to and from a binary representation. More...

#include <rtt/types/TypeMarshaller.hpp>

Inheritance diagram for RTT::types::TypeMarshaller:

Public Member Functions
virtual void *	createCookie () const
	Overload in subclasses for marshallers that need to allocate some internal data. More...

virtual void	deleteCookie (void *cookie) const
	Called to delete a cookie created with createCookie. More...

virtual std::pair< void const *, int >	fillBlob (base::DataSourceBase::shared_ptr source, void blob, int size, void cookie=0) const =0
	Create an transportable object for a protocol which contains the value of source. More...

virtual bool	updateFromBlob (const void blob, int size, base::DataSourceBase::shared_ptr target, void cookie=0) const =0
	Update target with the contents of blob which is an object of a protocol. More...

virtual unsigned int	getSampleSize (base::DataSourceBase::shared_ptr sample, void *cookie=0) const =0
	Returns the size in bytes of a marshalled data element. More...

virtual base::ChannelElementBase::shared_ptr	createStream (base::PortInterface *port, const ConnPolicy &policy, bool is_sender) const =0
	Creates a streaming channel element for reading or writing over this transport. More...

Detailed Description

Objects implementing this interface have the capability to convert data sources to and from a binary representation.

Definition at line 61 of file TypeMarshaller.hpp.

Member Function Documentation

virtual void* RTT::types::TypeMarshaller::createCookie ( ) const

inlinevirtual

Overload in subclasses for marshallers that need to allocate some internal data.

The protocol will call deleteCookie(void*) accordingly

Definition at line 68 of file TypeMarshaller.hpp.

Referenced by RTT::mqueue::MQSendRecv::setupStream().

virtual base::ChannelElementBase::shared_ptr RTT::types::TypeTransporter::createStream	(	base::PortInterface *	port,
		const ConnPolicy &	policy,
		bool	is_sender
	)		const

pure virtualinherited

Creates a streaming channel element for reading or writing over this transport.

It returns a ChannelElementBase that provides the implementation of sending or receiving data through the transport. Both sender and receiver find each other using the channel_id argument. Transports that do not support streaming may return null

Parameters

port	The port for which this channel is setup.
channel_id	If the transport receives a non-empty channel_id, it will create a channel that connects to this id. If channel id is empty, it will be filled in with a unique identifier that identifies this channel. This allows the local caller to connect to the remote channel in a second invocation of createRemoteChannel.
is_sender	Set to true in case you will write() to this channel element, set it to false in case you will read() from this channel element.

Returns: null in case streaming is not supported by this transport or a valid channel element otherwise.

Implemented in RTT::corba::CorbaFallBackProtocol, RTT::corba::CorbaTypeTransporter, and RTT::mqueue::MQTemplateProtocolBase< T >.

Referenced by RTT::corba::RemoteInputPort::buildRemoteChannelOutput(), RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), RTT::internal::ConnFactory::createAndCheckStream(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().

virtual void RTT::types::TypeMarshaller::deleteCookie ( void * cookie ) const

inlinevirtual

Called to delete a cookie created with createCookie.

Definition at line 70 of file TypeMarshaller.hpp.

References fillBlob(), getSampleSize(), and updateFromBlob().

Referenced by RTT::mqueue::MQSendRecv::cleanupStream().

virtual std::pair<void const*,int> RTT::types::TypeMarshaller::fillBlob	(	base::DataSourceBase::shared_ptr	source,
		void *	blob,
		int	size,
		void *	cookie = `0`
	)		const

pure virtual

Create an transportable object for a protocol which contains the value of source.

This must be a real-time function which does not allocate memory

Parameters

source	The data to be read
blob	Suggested target memory area to write to. In case the type marshaller does not need this, it will return an alternative as a first element in the returned std::pair.
size	The size of the memory area pointed by blob

Returns: Returns (0,0) if the filling failed, otherwise, points to the filled memory area and the effectively written size. The returned pointer may differ from blob, in case blob was not used. The returned size must be lower or equal than size

Implemented in RTT::mqueue::MQTemplateProtocol< T >, and RTT::mqueue::MQSerializationProtocol< T >.

Referenced by deleteCookie(), and RTT::mqueue::MQSendRecv::mqWrite().

virtual unsigned int RTT::types::TypeMarshaller::getSampleSize	(	base::DataSourceBase::shared_ptr	sample,
		void *	cookie = `0`
	)		const

pure virtual

Returns the size in bytes of a marshalled data element.

Returns: the size.

Implemented in RTT::mqueue::MQSerializationProtocol< T >, and RTT::mqueue::MQTemplateProtocol< T >.

Referenced by RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), RTT::internal::ConnFactory::createAndCheckStream(), deleteCookie(), RTT::mqueue::MQSendRecv::mqNewSample(), and RTT::mqueue::MQSendRecv::setupStream().

virtual bool RTT::types::TypeMarshaller::updateFromBlob	(	const void *	blob,
		int	size,
		base::DataSourceBase::shared_ptr	target,
		void *	cookie = `0`
	)		const

pure virtual

Update target with the contents of blob which is an object of a protocol.

The given data source is guaranteed to be an AssignableDataSource

Implemented in RTT::mqueue::MQSerializationProtocol< T >, and RTT::mqueue::MQTemplateProtocol< T >.

Referenced by deleteCookie(), RTT::mqueue::MQSendRecv::mqRead(), and RTT::mqueue::MQSendRecv::mqReady().

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

rtt/types/TypeMarshaller.hpp

Public Member Functions

Detailed Description

Member Function Documentation