Rti.Dds.Topics.ISerializer< T > Interface Template Reference

Allows serializing and deserializing IDL types as byte buffers More...

Inherits IDisposable.

Public Member Functions
byte[]	Serialize (T sample)
	Serializes a data sample into a byte array More...
unsafe uint	Serialize (T sample, byte *buffer, int length)
	Serializes a data sample into a byte array More...
T	Deserialize (byte[] buffer)
	Deserializes a data sample from a byte array More...
unsafe T	Deserialize (byte *buffer, int length)
	Deserializes a data sample from a byte buffer More...
uint	GetSerializedSampleMaxSize ()
	Calculates the maximum number of bytes that any data sample of type T may take in serialized form. More...
uint	GetSerializedSampleMinSize ()
	Calculates the minimum number of bytes that any data sample of type T may take in serialized form. More...
uint	GetSerializedSampleSize (T sample)
	Calculates the exact number of bytes that a given data sample takes in serialized form. More...
DynamicData	ToDynamicData (T sample)
	Converts a T sample into a DynamicData sample. More...
T	FromDynamicData (DynamicData sample)
	Converts a DynamicData sample into a T sample. More...

Properties
bool	IsUnbounded [get]
	Returns true if this type's serialized sample maximum size is unbounded More...

Detailed Description

Allows serializing and deserializing IDL types as byte buffers

Template Parameters

T	A type generated from IDL

To create an ISerializer, use TypeSupport<T>.CreateSerializer.

Warning

The ISerializer methods are not thread-safe. To use them in multiple threads, either protect them or create a different ISerializer per thread

This type is IDisposable, but it automatically calls Dispose() in its destructor.

This interface has extension methods, see Rti.Dds.Topics.SerializerExtensions .

See also

IDL examples

Member Function Documentation

Serialize() [1/2]

byte[] Rti.Dds.Topics.ISerializer< T >.Serialize

(

T

sample

)

Serializes a data sample into a byte array

Parameters

sample

A data sample

Returns

A new byte array containing the serialized data

Serialize() [2/2]

unsafe uint Rti.Dds.Topics.ISerializer< T >.Serialize	(	T	sample,
		byte *	buffer,
		int	length
	)

Serializes a data sample into a byte array

Parameters

sample	A data sample
buffer	A byte buffer with enough space to contain the serialized data
length	The available length of the byte buffer. This operation throws DdsException if the data doesn't fit. You can obtain the exact size required for this sample with GetSerializedSampleSize or a size that is guaranteed to suffice for any sample of this type with GetSerializedSampleMaxSize.

Returns

The actual number of bytes that were serialized

Deserialize() [1/2]

T Rti.Dds.Topics.ISerializer< T >.Deserialize

(

byte[]

buffer

)

Deserializes a data sample from a byte array

Parameters

buffer

A byte array containing the serialized data

Returns

A new data sample created by deserializing the buffer

Deserialize() [2/2]

unsafe T Rti.Dds.Topics.ISerializer< T >.Deserialize	(	byte *	buffer,
		int	length
	)

Deserializes a data sample from a byte buffer

Parameters

buffer	A byte buffer containing the serialized data
length	The length of the byte buffer

Returns

A new data sample created by deserializing the buffer

GetSerializedSampleMaxSize()

uint Rti.Dds.Topics.ISerializer< T >.GetSerializedSampleMaxSize

(

)

Calculates the maximum number of bytes that any data sample of type T may take in serialized form.

GetSerializedSampleMinSize()

uint Rti.Dds.Topics.ISerializer< T >.GetSerializedSampleMinSize

(

)

Calculates the minimum number of bytes that any data sample of type T may take in serialized form.

GetSerializedSampleSize()

uint Rti.Dds.Topics.ISerializer< T >.GetSerializedSampleSize

(

T

sample

)

Calculates the exact number of bytes that a given data sample takes in serialized form.

Parameters

sample

The data sample

Returns

The number of bytes that the sample needs to be serialized

ToDynamicData()

DynamicData Rti.Dds.Topics.ISerializer< T >.ToDynamicData

(

T

sample

)

Converts a T sample into a DynamicData sample.

Parameters

sample

The sample to convert

Returns

A copy of sample as a DynamicData object

FromDynamicData()

T Rti.Dds.Topics.ISerializer< T >.FromDynamicData

(

DynamicData

sample

)

Converts a DynamicData sample into a T sample.

Parameters

sample

The sample to convert

Returns

A copy of sample as an instance of type T

This method requires that sample.Type and TSupport.Instance.DynamicType be equal.

Property Documentation

IsUnbounded

bool Rti.Dds.Topics.ISerializer< T >.IsUnbounded

get

Returns true if this type's serialized sample maximum size is unbounded