This module contains common definitions used across other functional modules. More...

Modules
	Standard Error Codes
	Standard error codes.

	Standard Type Representation Kinds
	Standard type Representation kinds.

	Standard Data Representation Kinds
	Standard data representation kinds.

Data Structures
struct	RTI_RoutingServiceNameValue
	Configuration property. More...

struct	RTI_RoutingServiceProperties
	Set of configuration properties. More...

struct	RTI_RoutingServiceVersion
	Represents the version of a plugin or RTI Routing Service itself. More...

struct	RTI_RoutingServiceTypeInfo
	Type information. More...

struct	RTI_RoutingServiceStringSeq
	Definition of a String sequence. More...

struct	RTI_RoutingServiceStreamInfo
	Stream information. More...

Macros
#define	RTI_USER_DLL_EXPORT
	Utility macro that can be used to export symbols in a shared library on Windows platform. For non-windows, the definion of this macro is empty.

#define	RTI_UNUSED_PARAMETER(x) (void)(x)
	This can be used by C client and example code to avoid unused parameter warnings in the compiler. This is not strictly necessary in C++, where just removing the parameter name should yield the same result.

#define	RTI_ROUTING_SERVICE_ERROR_MAX_LENGTH 1024
	Maximum length of an error message.

#define	RTI_ROUTING_SERVICE_APP_NAME_PROPERTY_NAME "rti.routing_service.app_name"
	Name of the property that provides the RTI Routing Service given application name.

#define	RTI_ROUTING_SERVICE_GROUP_PROPERTY_NAME "rti.routing_service.group_name"

#define	RTI_ROUTING_SERVICE_VERSION_PROPERTY_NAME "rti.routing_service.version"
	Name of the property that provides the RTI Routing Service version as string.

#define	RTI_ROUTING_SERVICE_VERBOSITY_PROPERTY_NAME "rti.routing_service.verbosity"
	Name of the property that provides verbosity in use by RTI Routing Service.

#define	RTI_ROUTING_SERVICE_ENTITY_RESOURCE_NAME_PROPERTY_NAME "rti.routing_service.entity.resource_name"
	Name of the property that provides the resource name of the entity that owns the adapter entity.

Typedefs
typedef struct RTI_RoutingServiceEnvironmentImpl	RTI_RoutingServiceEnvironment
	The environment permits the return of error information in the RTI Routing Service API and information retreival (version and verbosity).

typedef int	RTI_RoutingServiceTypeRepresentationKind
	Type representation kind.

typedef void *	RTI_RoutingServiceTypeRepresentation
	Type representation.

typedef int	RTI_RoutingServiceDataRepresentationKind
	Data representation kind.

typedef void *	RTI_RoutingServiceSample
	Stream sample.

typedef void *	RTI_RoutingServiceSampleInfo
	Stream sample info.

Enumerations
enum	RTI_RoutingServiceVerbosity { RTI_ROUTING_SERVICE_VERBOSITY_NONE = 0, RTI_ROUTING_SERVICE_VERBOSITY_EXCEPTION, RTI_ROUTING_SERVICE_VERBOSITY_WARN, RTI_ROUTING_SERVICE_VERBOSITY_INFO, RTI_ROUTING_SERVICE_VERBOSITY_DEBUG }
	Verbosity used by Routing Service. More...

Functions
const char *	RTI_RoutingServiceProperties_lookup_property (const struct RTI_RoutingServiceProperties self, const char name)
	Searches for a property given its name.

void	RTI_RoutingServiceEnvironment_set_error_w_params (RTI_RoutingServiceEnvironment self, int overwrite, int error_code, int native_error_code, const char error_format,...)
	Assigns an error into the environment.

void	RTI_RoutingServiceEnvironment_set_error (RTI_RoutingServiceEnvironment self, const char error_format,...)
	Assigns an error into the environment.

void	RTI_RoutingServiceEnvironment_clear_error (RTI_RoutingServiceEnvironment *self)
	Clears an error (if any) set in this environment.

RTI_RoutingServiceVerbosity	RTI_RoutingServiceEnvironment_get_verbosity (const RTI_RoutingServiceEnvironment *self)
	Retrieves the verbosity that Routing Service is using.

int	RTI_RoutingServiceEnvironment_error_occurred (const RTI_RoutingServiceEnvironment *self)
	Checks whether an error has been set in this environment.

const char *	RTI_RoutingServiceEnvironment_get_error_message (const RTI_RoutingServiceEnvironment *self)
	Returns the error message this environment contains.

struct RTI_RoutingServiceStreamInfo *	RTI_RoutingServiceStreamInfo_new_discovered (const char stream_name, const char registered_type_name, RTI_RoutingServiceTypeRepresentationKind type_representation_kind, RTI_RoutingServiceTypeRepresentation type_representation)
	Creates a stream info for a newly discovered stream.

struct RTI_RoutingServiceStreamInfo *	RTI_RoutingServiceStreamInfo_new_disposed (const char *stream_name)
	Creates a stream info for a disposed stream.

void	RTI_RoutingServiceStreamInfo_delete (struct RTI_RoutingServiceStreamInfo *self)
	Destroys a stream info.

Detailed Description

This module contains common definitions used across other functional modules.

Macro Definition Documentation

#define RTI_USER_DLL_EXPORT

Utility macro that can be used to export symbols in a shared library on Windows platform. For non-windows, the definion of this macro is empty.

#define RTI_UNUSED_PARAMETER ( x ) (void)(x)

This can be used by C client and example code to avoid unused parameter warnings in the compiler. This is not strictly necessary in C++, where just removing the parameter name should yield the same result.

#define RTI_ROUTING_SERVICE_ERROR_MAX_LENGTH 1024

Maximum length of an error message.

Error messages longer than this value are truncated.

#define RTI_ROUTING_SERVICE_APP_NAME_PROPERTY_NAME "rti.routing_service.app_name"

Name of the property that provides the RTI Routing Service given application name.

#define RTI_ROUTING_SERVICE_GROUP_PROPERTY_NAME "rti.routing_service.group_name"

Name of the property that provides the configured group name.

#define RTI_ROUTING_SERVICE_VERSION_PROPERTY_NAME "rti.routing_service.version"

Name of the property that provides the RTI Routing Service version as string.

#define RTI_ROUTING_SERVICE_VERBOSITY_PROPERTY_NAME "rti.routing_service.verbosity"

Name of the property that provides verbosity in use by RTI Routing Service.

It can take on of the following stings:

NONE
EXCEPTION
WARN
INFO
DEBUG.

#define RTI_ROUTING_SERVICE_ENTITY_RESOURCE_NAME_PROPERTY_NAME "rti.routing_service.entity.resource_name"

Name of the property that provides the resource name of the entity that owns the adapter entity.

Typedef Documentation

typedef struct RTI_RoutingServiceEnvironmentImpl RTI_RoutingServiceEnvironment

The environment permits the return of error information in the RTI Routing Service API and information retreival (version and verbosity).

This is the last parameter of each operation.

See Also: RTI_RoutingServiceEnvironment_set_error; RTI_RoutingServiceEnvironment_get_verbosity

typedef int RTI_RoutingServiceTypeRepresentationKind

Type representation kind.

The range [0-100] is reserved for RTI use. Within that range are some predefined type representations (Standard Type Representation Kinds).

typedef void* RTI_RoutingServiceTypeRepresentation

Type representation.

If the representation kind is RTI_ROUTING_SERVICE_TYPE_REPRESENTATION_DYNAMIC_TYPE, the representation will be an RTI Connext TypeCode.

If the representation kind is RTI_ROUTING_SERVICE_TYPE_REPRESENTATION_XML, the representation will be an XML string.

typedef int RTI_RoutingServiceDataRepresentationKind

Data representation kind.

The range [0-100] is reserved for RTI use. Within that range are some predefined data representations (Standard Data Representation Kinds).

typedef void* RTI_RoutingServiceSample

Stream sample.

Samples are data messages generated by adapters and transformations.

If the representation kind is RTI_ROUTING_SERVICE_DATA_REPRESENTATION_DYNAMIC_DATA, the sample will be a DynamicData object.

If the representation kind is RTI_ROUTING_SERVICE_DATA_REPRESENTATION_XML, the sample will be an XML string.

typedef void* RTI_RoutingServiceSampleInfo

Stream sample info.

In DDS, this is a DDS_SampleInfo object.

Enumeration Type Documentation

enum RTI_RoutingServiceVerbosity

Verbosity used by Routing Service.

Enumerator:

RTI_ROUTING_SERVICE_VERBOSITY_NONE	No logging (-verbosity 0)
RTI_ROUTING_SERVICE_VERBOSITY_EXCEPTION	Exceptions (-verbosity 1)
RTI_ROUTING_SERVICE_VERBOSITY_WARN	Warnings (-verbosity 2)
RTI_ROUTING_SERVICE_VERBOSITY_INFO	Information (-verbosity 3)
RTI_ROUTING_SERVICE_VERBOSITY_DEBUG	Debug information (-verbosity 5 and 6)

Function Documentation

const char* RTI_RoutingServiceProperties_lookup_property	(	const struct RTI_RoutingServiceProperties *	self,
		const char *	name
	)

Searches for a property given its name.

Parameters

self	<<in>> Cannot be NULL.
name	<<in>> Property name. Cannot be NULL.

Returns: On success, the function returns the value of the first property with the given name. Otherwise, the function returns NULL.

void RTI_RoutingServiceEnvironment_set_error_w_params	(	RTI_RoutingServiceEnvironment *	self,
		int	overwrite,
		int	error_code,
		int	native_error_code,
		const char *	error_format,
			...
	)

Assigns an error into the environment.

Routing Service will consider that a function call failed when an error has been set into the environment

Parameters

self	<<in>> Cannot be NULL.
overwrite	<<in>> If the environment already contains an error, setting this parameter to 1 will overwrite it.
error_code	<<in>> One of the Standard Error Codes.
native_error_code	<<in>> Native error code (specific to the transformation or adapter plugin).
error_format	<<in>> String that contains the error text. It can optionally contain format tags that are substituted by the values specified in subsequent argument(s). Cannot be NULL. The format tags are the same tags used by the function printf in the ANSI C standard.

See Also: RTI_RoutingServiceEnvironment_set_error

void RTI_RoutingServiceEnvironment_set_error	(	RTI_RoutingServiceEnvironment *	self,
		const char *	error_format,
			...
	)

Assigns an error into the environment.

Routing Service will consider that a function call failed when an error has been set into the environment

This function sets the error code to RTI_ROUTING_SERVICE_ERROR and the native error code to 0.

If the environment already contains an error, the error is not overwritten.

Parameters

self	<<in>> Cannot be NULL.
error_format	<<in>> String that contains the error text. It can optionally contain format tags that are substituted by the values specified in subsequent argument(s). Cannot be NULL. The format tags are the same tags used by the function printf in the ANSI C standard.

See Also: RTI_RoutingServiceEnvironment_set_error_w_params

void RTI_RoutingServiceEnvironment_clear_error ( RTI_RoutingServiceEnvironment * self )

Clears an error (if any) set in this environment.

Parameters

self	<<in>> Cannot be NULL.

RTI_RoutingServiceVerbosity RTI_RoutingServiceEnvironment_get_verbosity ( const RTI_RoutingServiceEnvironment * self )

Retrieves the verbosity that Routing Service is using.

Parameters

self	<<in>> Cannot be NULL.

Returns: The verbosity

int RTI_RoutingServiceEnvironment_error_occurred ( const RTI_RoutingServiceEnvironment * self )

Checks whether an error has been set in this environment.

Parameters

self	<<in>> Cannot be NULL.

Returns: A value different than zero if true

const char* RTI_RoutingServiceEnvironment_get_error_message ( const RTI_RoutingServiceEnvironment * self )

Returns the error message this environment contains.

Parameters

self	<<in>> Cannot be NULL.

Returns: The error message or NULL if no error is set

struct RTI_RoutingServiceStreamInfo* RTI_RoutingServiceStreamInfo_new_discovered	(	const char *	stream_name,
		const char *	registered_type_name,
		RTI_RoutingServiceTypeRepresentationKind	type_representation_kind,
		RTI_RoutingServiceTypeRepresentation	type_representation
	)

read

Creates a stream info for a newly discovered stream.

Parameters

stream_name	<<in>> Stream name. Cannot be NULL.
registered_type_name	<<in>> Type name. Cannot be NULL.
type_representation_kind	<<in>> Type representation kind.
type_representation	<<in>> Type representation. Cannot be NULL.

Returns: Newly created stream info, or NULL if there is an error.

struct RTI_RoutingServiceStreamInfo* RTI_RoutingServiceStreamInfo_new_disposed ( const char * stream_name )

read

Creates a stream info for a disposed stream.

Disposed streams are no longer available in a data domain.

Parameters

stream_name <<in>> Stream name. Cannot be NULL.

Returns: Newly created stream info, or NULL if there is an error.

void RTI_RoutingServiceStreamInfo_delete ( struct RTI_RoutingServiceStreamInfo * self )

Destroys a stream info.

Parameters

self	<<in>> Cannot be NULL.

Modules

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation