Compliance Configuration

APIs to configure compliance with certain standard specifications. More...

Classes
class	rti::config::compliance::XTypesMask
	This mask configures different aspects of the Extended CDR encoding (XCDR and XCDR2). More...
class	rti::config::compliance::RpcMask
	XTypes compliance mask. More...

Functions
XTypesMask	rti::config::compliance::get_xtypes_mask ()
	Gets the XTypes compliance mask value for the application. More...
void	rti::config::compliance::set_xtypes_mask (XTypesMask mask)
	Sets the level of compliance of the application with the XTypes specification. More...
void	rti::config::compliance::load_compliance_masks ()
	Load the compliance masks from the environment variables. More...
RpcMask	rti::config::compliance::get_rpc_mask ()
	Gets the RPC compliance mask value for the application. More...
void	rti::config::compliance::set_rpc_mask (RpcMask mask)
	Sets the level of compliance of the application with the Rpc specification. More...

Detailed Description

APIs to configure compliance with certain standard specifications.

Function Documentation

get_xtypes_mask()

XTypesMask rti::config::compliance::get_xtypes_mask

(

)

Gets the XTypes compliance mask value for the application.

#include <rti/config/Compliance.hpp>

Note

This is a standalone function in the namespace rti::config::compliance

The rti::config::compliance::XTypesMask configures different aspects of the Extended CDR encoding (XCDR and XCDR2) for the application.

Returns

The rti::config::compliance::XTypesMask value.

See also

rti::config::compliance::XTypesMask

rti::config::compliance::get_xtypes_mask()

rti::config::compliance::load_compliance_masks()

set_xtypes_mask()

void rti::config::compliance::set_xtypes_mask

(

XTypesMask

mask

)

Sets the level of compliance of the application with the XTypes specification.

#include <rti/config/Compliance.hpp>

Note

This is a standalone function in the namespace rti::config::compliance

The rti::config::compliance::XTypesMask configures different aspects of the Extended CDR encoding (XCDR and XCDR2) for the application.

Once you call this function the value of the mask will apply to all the DomainParticipants created after the call. It won't apply to DomainParticipants created before the call.

In general, applications should only set the mask once, before executing any other RTI Connext API. The mask can also be set using the environment variable NDDS_XTYPES_COMPLIANCE_MASK.

Parameters

mask	<<in>> Compliance mask.

See also

rti::config::compliance::XTypesMask

rti::config::compliance::get_xtypes_mask()

rti::config::compliance::load_compliance_masks()

load_compliance_masks()

void rti::config::compliance::load_compliance_masks

(

)

Load the compliance masks from the environment variables.

#include <rti/config/Compliance.hpp>

Note

This is a standalone function in the namespace rti::config::compliance

This function loads the XTypes and RPC compliance masks from the environment, which can be set using the environment variables NDDS_XTYPES_COMPLIANCE_MASK and NDDS_RPC_COMPLIANCE_MASK.

See also

rti::config::compliance::XTypesMask

rti::config::compliance::set_xtypes_mask()

rti::config::compliance::get_xtypes_mask()

rti::config::compliance::RpcMask

rti::config::compliance::set_rpc_mask()

rti::config::compliance::get_rpc_mask()

get_rpc_mask()

RpcMask rti::config::compliance::get_rpc_mask

(

)

Gets the RPC compliance mask value for the application.

#include <rti/config/Compliance.hpp>

Note

This is a standalone function in the namespace rti::config::compliance

The rti::config::compliance::RpcMask configures different aspects of RPC communication.

Returns

The rti::config::compliance::RpcMask value.

See also

rti::config::compliance::RpcMask

rti::config::compliance::get_rpc_mask()

rti::config::compliance::load_compliance_masks()

set_rpc_mask()

void rti::config::compliance::set_rpc_mask

(

RpcMask

mask

)

Sets the level of compliance of the application with the Rpc specification.

#include <rti/config/Compliance.hpp>

Note

This is a standalone function in the namespace rti::config::compliance

The rti::config::compliance::RpcMask configures different aspects of RPC communication.

Once you call this function the value of the mask will apply to all the DomainParticipants created after the call. It won't apply to DomainParticipants created before the call.

In general, applications should only set the mask once, before executing any other RTI Connext API. The mask can also be set using the environment variable NDDS_RPC_COMPLIANCE_MASK.

Parameters

mask	<<in>> Compliance mask.

See also

rti::config::compliance::RpcMask

rti::config::compliance::get_rpc_mask()

rti::config::compliance::load_compliance_masks()