adapter.ifc File Reference

RTI Routing Service C Adapter API. More...

#include "routingservice/routingservice_infrastructure.h"

Data Structures
struct	RTI_RoutingServiceStreamReaderListener
	StreamReader listener used to notify Routing Service that new data is available. More...
struct	RTI_RoutingServiceAdapterPlugin
	Adapter plugin. More...

Macros
#define	RTI_RoutingServiceAdapterPlugin_initialize(adapter)
	Initializes the adapter plugin structure.

Typedefs
typedef void *	RTI_RoutingServiceStreamWriter
	StreamWriter.
typedef int(*	RTI_RoutingServiceStreamWriter_WriteFcn )(RTI_RoutingServiceStreamWriter stream_writer, const RTI_RoutingServiceSample *sample_list, const RTI_RoutingServiceSampleInfo *info_list, int count, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that writes a collection of data samples to an output stream.
typedef void *	RTI_RoutingServiceStreamReader
	StreamReader.
typedef void(*	RTI_RoutingServiceStreamReaderListener_OnDataAvailableCallback )(RTI_RoutingServiceStreamReader stream_reader, void *listener_data)
	Prototype of the callback used to notify of new samples.
typedef void(*	RTI_RoutingServiceStreamReader_ReadFcn )(RTI_RoutingServiceStreamReader stream_reader, RTI_RoutingServiceSample **sample_list, RTI_RoutingServiceSampleInfo **info_list, int *count, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that reads a collection of data samples and sample infos from an input stream.
typedef void(*	RTI_RoutingServiceStreamReader_ReturnLoanFcn )(RTI_RoutingServiceStreamReader stream_reader, RTI_RoutingServiceSample *sample_list, RTI_RoutingServiceSampleInfo *info_list, int count, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that returns the loan on the read samples and infos.
typedef void *	RTI_RoutingServiceSession
	Session.
typedef void *	RTI_RoutingServiceConnection
	Connection.
typedef const char *(*	RTI_RoutingServiceConnection_ToStringFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that returns the string representation of a connection for logging purposes.
typedef RTI_RoutingServiceSession(*	RTI_RoutingServiceConnection_CreateSessionFcn )(RTI_RoutingServiceConnection connection, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that creates a Session.
typedef void(*	RTI_RoutingServiceConnection_DeleteSessionFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceSession session, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes a Session.
typedef RTI_RoutingServiceStreamReader(*	RTI_RoutingServiceConnection_CreateStreamReaderFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceSession session, const struct RTI_RoutingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties, const struct RTI_RoutingServiceStreamReaderListener *listener, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that creates a StreamReader.
typedef void(*	RTI_RoutingServiceConnection_DeleteStreamReaderFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceStreamReader stream_reader, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes a StreamReader.
typedef RTI_RoutingServiceStreamWriter(*	RTI_RoutingServiceConnection_CreateStreamWriterFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceSession session, const struct RTI_RoutingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that creates a StreamWriter.
typedef void(*	RTI_RoutingServiceConnection_DeleteStreamWriterFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceStreamWriter stream_writer, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes a StreamWriter.
typedef RTI_RoutingServiceStreamReader(*	RTI_RoutingServiceConnection_GetDiscoveryReaderFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that gets a built-in discovery StreamReader.
typedef RTI_RoutingServiceTypeRepresentation(*	RTI_RoutingServiceConnection_CopyTypeRepresentationFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceTypeRepresentationKind type_representation_kind, RTI_RoutingServiceTypeRepresentation type_representation, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that copies a type representation.
typedef void(*	RTI_RoutingServiceConnection_DeleteTypeRepresentationFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceTypeRepresentationKind type_representation_kind, RTI_RoutingServiceTypeRepresentation type_representation, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes a type representation.
typedef struct RTI_RoutingServiceProperties *(*	RTI_RoutingServiceConnection_GetAttributesFcn )(RTI_RoutingServiceConnection connection, RTI_RoutingServiceEnvironment *env)
	[Not supported] Prototype of the function that returns the Connection attributes.
typedef void *	RTI_RoutingServiceAdapterEntity
	Adapter entity.
typedef void(*	RTI_RoutingServiceAdapterEntity_UpdateFcn )(RTI_RoutingServiceAdapterEntity entity, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that updates the configuration of an adapter entity.
typedef void(*	RTI_RoutingServiceAdapterPlugin_DeleteConnectionFcn )(struct RTI_RoutingServiceAdapterPlugin *plugin, RTI_RoutingServiceConnection connection, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes a Connection.
typedef RTI_RoutingServiceConnection(*	RTI_RoutingServiceAdapterPlugin_CreateConnectionFcn )(struct RTI_RoutingServiceAdapterPlugin *plugin, const char *routing_service_name, const char *routing_service_group_name, const struct RTI_RoutingServiceStreamReaderListener *input_stream_discovery_listener, const struct RTI_RoutingServiceStreamReaderListener *output_stream_discovery_listener, const struct RTI_RoutingServiceTypeInfo **registeredTypes, int registeredTypeCount, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that creates a Connection.
typedef void(*	RTI_RoutingServiceAdapterPlugin_DeleteFcn )(struct RTI_RoutingServiceAdapterPlugin *plugin, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that deletes an adapter plugin.
typedef struct RTI_RoutingServiceAdapterPlugin *(*	RTI_RoutingServiceAdapterPlugin_CreateFcn )(const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
	Prototype of the function that creates an adapter plugin.

Detailed Description

RTI Routing Service C Adapter API.

Typedef Documentation

typedef void(* RTI_RoutingServiceAdapterPlugin_DeleteConnectionFcn)(struct RTI_RoutingServiceAdapterPlugin *plugin, RTI_RoutingServiceConnection connection, RTI_RoutingServiceEnvironment *env)

Prototype of the function that deletes a Connection.

Connection objects are deleted when the domain routes that contain them are disabled or RTI Routing Service is closed.

Required: Yes

Parameters

plugin	<<in>> Adapter plugin.
connection	<<in>> Connection to be deleted
env	<<inout>> Environment for error indications.

See Also

RTI_RoutingServiceAdapterPlugin_CreateConnectionFcn

typedef RTI_RoutingServiceConnection(* RTI_RoutingServiceAdapterPlugin_CreateConnectionFcn)(struct RTI_RoutingServiceAdapterPlugin *plugin, const char *routing_service_name, const char *routing_service_group_name, const struct RTI_RoutingServiceStreamReaderListener *input_stream_discovery_listener, const struct RTI_RoutingServiceStreamReaderListener *output_stream_discovery_listener, const struct RTI_RoutingServiceTypeInfo **registeredTypes, int registeredTypeCount, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)

Prototype of the function that creates a Connection.

A Connection provides access to a data domain (such as a DDS domain or a JMS network provider).

Connection objects are created when the domain routes that contain them are enabled.

In the XML configuration file, Connections are associated with the tags <connection_1> and <connection_2> within a domain route.

Required: Yes

Parameters

plugin	<<in>> Adapter plugin.
routing_service_name	<<in>> The routing service execution name.
routing_service_group_name	<<in>> The group name of the routing service execution.
input_stream_discovery_listener	<<in>> The listener of the built-in StreamReader that notifies the discovery of new input streams.
output_stream_discovery_listener	<<in>> The listener of the built-in StreamReader that notifies the discovery of new output streams.
registeredTypes	<<in>> A list of types that are registered in the corresponding XML connection with the tag <registered_type>
registeredTypeCount	<<in>> The number of elements of registeredTypes
properties	<<in>> Configuration properties for the Connection.
env	<<inout>> Environment for error indications.

Returns

New Connection if successful. Otherwise, NULL.

See Also

RTI_RoutingServiceAdapterPlugin_DeleteConnectionFcn