RTI Connext .Net APIs  Version 5.2.0
 All Classes Namespaces Functions Variables Enumerations Properties Groups Pages
DDS::BytesTypeSupport Class Reference

<<interface>> DDS::Bytes type support. More...

#include <managed_bytesSupport.h>

Inherits DDS::TypedTypeSupport< T >.

Static Public Member Functions

static System::String^ get_type_name ()
 Get the default name for the DDS::Bytes type.
 
static void print_data (Bytes^ a_data)
 <<extension>> Print value of data type to standard out.
 
static void serialize_data_to_cdr_buffer (array< System::Byte >^buffer, System::UInt32% length, Bytes^ a_data)
 <<extension>> Serializes the input sample into a buffer of octets.
 
static void deserialize_data_from_cdr_buffer (Bytes^ a_data, array< System::Byte >^buffer, System::UInt32 length)
 <<extension>> Deserializes a sample from a buffer of octets.
 
static DDS::TypeCodeget_typecode ()
 <<extension>> Retrieves the TypeCode for the Type.
 
static void register_type (DDS::DomainParticipant^ participant, System::String^ type_name)
 Allows an application to communicate to RTI Connext the existence of the DDS::Bytes data type.
 
static void unregister_type (DDS::DomainParticipant^ participant, System::String^ type_name)
 Allows an application to unregister the DDS::Bytes data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
 

Detailed Description

<<interface>> DDS::Bytes type support.

Member Function Documentation

static System::String ^ DDS::BytesTypeSupport::get_type_name ( )
static

Get the default name for the DDS::Bytes type.

Can be used for calling DDS::BytesTypeSupport::register_type or creating DDS::Topic.

Returns
default name for the DDS::Bytes type.
See Also
DDS::BytesTypeSupport::register_type
DDS::DomainParticipant::create_topic
static void DDS::BytesTypeSupport::print_data ( Bytes a_data)
static

<<extension>> Print value of data type to standard out.

The generated implementation of the operation knows how to print value of a data type.

Parameters
a_data<<in>> DDS::Bytes to be printed.
static void DDS::BytesTypeSupport::serialize_data_to_cdr_buffer ( array< System::Byte >^  buffer,
System::UInt32%  length,
Bytes a_data 
)
static

<<extension>> Serializes the input sample into a buffer of octets.

See Also
FooTypeSupport::serialize_data_to_cdr_buffer
static void DDS::BytesTypeSupport::deserialize_data_from_cdr_buffer ( Bytes a_data,
array< System::Byte >^  buffer,
System::UInt32  length 
)
static

<<extension>> Deserializes a sample from a buffer of octets.

See Also
FooTypeSupport::deserialize_data_from_cdr_buffer
static DDS::TypeCode ^ DDS::BytesTypeSupport::get_typecode ( )
static

<<extension>> Retrieves the TypeCode for the Type.

See Also
FooTypeSupport::get_typecode
static void DDS::BytesTypeSupport::register_type ( DDS::DomainParticipant participant,
System::String^  type_name 
)
static

Allows an application to communicate to RTI Connext the existence of the DDS::Bytes data type.

By default, The DDS::Bytes built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDS::BytesTypeSupport::get_type_name. Therefore, the usage of this function is optional and it is only required when the automatic built-in type registration is disabled using the participant property "dds.builtin_type.auto_register".

This method can also be used to register the same DDS::BytesTypeSupport with a DDS::DomainParticipant using different values for the type_name.

If register_type is called multiple times with the same DDS::DomainParticipant and type_name, the second (and subsequent) registrations are ignored by the operation.

Parameters
participant<<in>> the DDS::DomainParticipant to register the data type DDS::Bytes with. Cannot be null.
type_name<<in>> the type name under with the data type DDS::Bytes is registered with the participant; this type name is used when creating a new DDS::Topic. (See DDS::DomainParticipant::create_topic.) The name may not be null or longer than 255 characters.
Exceptions
Oneof the Standard Return Codes, DDS::Retcode_PreconditionNotMet or DDS::Retcode_OutOfResources.
MT Safety:
UNSAFE on the FIRST call. It is not safe for two threads to simultaneously make the first call to register a type. Subsequent calls are thread safe.
See Also
DDS::DomainParticipant::create_topic
static void DDS::BytesTypeSupport::unregister_type ( DDS::DomainParticipant participant,
System::String^  type_name 
)
static

Allows an application to unregister the DDS::Bytes data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.

Precondition
The DDS::Bytes type with type_name is registered with the participant and all DDS::Topic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any DDS::Topic is associated with the type, the operation will fail with DDS::Retcode_Error.
Postcondition
All information about the type is removed from RTI Connext. No further communication using this type is possible.
Parameters
participant<<in>> the DDS::DomainParticipant to unregister the data type DDS::Bytes from. Cannot be null.
type_name<<in>> the type name under with the data type DDS::Bytes is registered with the participant. The name should match a name that has been previously used to register a type with the participant. Cannot be null.
Exceptions
Oneof the Standard Return Codes, DDS::Retcode_BadParameter or DDS::Retcode_Error
MT Safety:
SAFE.
See Also
DDS::BytesTypeSupport::register_type

RTI Connext .Net APIs Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc