RTI Routing Service Version 7.4.0
routingservice_processor.h File Reference

RTI Routing Service Processor API. More...

#include "routingservice/routingservice_infrastructure.h"
#include "routingservice/routingservice_adapter_new.h"

Go to the source code of this file.

Data Structures

struct  RTI_RoutingServiceLoanedSamples
 A pair of sample and sample info arrays. They are assumed to be of the same length. More...
 
struct  RTI_RoutingServiceProcessor
 Main Processor class. More...
 
struct  RTI_RoutingServiceProcessorPlugin
 ProcessorPlugin class. More...
 

Macros

#define RTI_RoutingServiceProcessorPlugin_initialize(plugin)
 Utility macro to initialize a ProcessorPlugin object. More...
 

Typedefs

typedef void(* RTI_RoutingServiceProcessor_OnRouteEventFcn) (void *processor_data, RTI_RoutingServiceRouteEvent *route_event, RTI_RoutingServiceEnvironment *env)
 Prototype of the function that processes an event that occurred in the Route where the Processor is installed. More...
 
typedef void(* RTI_RoutingServiceProcessor_UpdateFcn) (void *processor_data, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
 Prototype of the function that updates a Processor configuration. More...
 
typedef struct RTI_RoutingServiceProcessorPlugin *(* RTI_RoutingServiceProcessorPlugin_CreateFcn) (const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
 Prototype of the function that creates a ProcessorPlugin. More...
 
typedef void(* RTI_RoutingServiceProcessorPlugin_DeleteFcn) (struct RTI_RoutingServiceProcessorPlugin *plugin, RTI_RoutingServiceEnvironment *env)
 Prototype of the function that deletes a ProcessorPlugin. More...
 
typedef struct RTI_RoutingServiceProcessor *(* RTI_RoutingServiceProcessorPlugin_CreateProcessorFcn) (void *processor_plugin_data, RTI_RoutingServiceRoute *route, const struct RTI_RoutingServiceProperties *properties, RTI_RoutingServiceEnvironment *env)
 Prototype of the function that creates a route Processor. More...
 

Enumerations

enum  RTI_RoutingServiceRouteEventKind
 Representation of the different event kinds triggered for a Route. More...
 

Functions

const char * RTI_RoutingServiceInput_get_name (RTI_RoutingServiceInput *self)
 Returns the name of the specified input. More...
 
const struct RTI_RoutingServiceStreamInfoRTI_RoutingServiceInput_get_stream_info (RTI_RoutingServiceInput *self)
 
DDS_Boolean RTI_RoutingServiceInput_is_active (RTI_RoutingServiceInput *self)
 Checks whether an Input is active. More...
 
DDS_Boolean RTI_RoutingServiceInput_take (RTI_RoutingServiceInput *self, struct RTI_RoutingServiceLoanedSamples *loaned_samples)
 Takes all the available samples in this Input into the specified loaned samples instance. More...
 
DDS_Boolean RTI_RoutingServiceInput_take_w_selector (RTI_RoutingServiceInput *self, struct RTI_RoutingServiceLoanedSamples *loaned_samples, const struct RTI_RoutingServiceSelectorState *selector)
 Takes all the available samples in this Input into the specified loaned samples instance, filtering samples based on the given data selector. More...
 
DDS_Boolean RTI_RoutingServiceInput_read (RTI_RoutingServiceInput *self, struct RTI_RoutingServiceLoanedSamples *loaned_samples)
 Reads all the available samples in this Input into the specified loaned samples instance. More...
 
DDS_Boolean RTI_RoutingServiceInput_read_w_selector (RTI_RoutingServiceInput *self, struct RTI_RoutingServiceLoanedSamples *loaned_samples, const struct RTI_RoutingServiceSelectorState *selector)
 Reads all the available samples in this Input into the specified loaned samples instance, filtering samples based on the given data selector. Cannot be null. More...
 
DDS_Boolean RTI_RoutingServiceInput_return_loan (RTI_RoutingServiceInput *self, struct RTI_RoutingServiceLoanedSamples *loaned_samples)
 Returns a loan on the read or taken samples. More...
 
RTI_RoutingServiceSelectorStateQueryData RTI_RoutingServiceInput_create_content_query (RTI_RoutingServiceInput *self, RTI_RoutingServiceSelectorStateQueryData old_query_data, const struct RTI_RoutingServiceSelectorContent *content)
 Creates a query object that selects the data with the specified filter. More...
 
DDS_Boolean RTI_RoutingServiceInput_delete_content_query (RTI_RoutingServiceInput *self, RTI_RoutingServiceSelectorStateQueryData query_data)
 Deletes a content query created from this Input. More...
 
const char * RTI_RoutingServiceOutput_get_name (RTI_RoutingServiceOutput *self)
 Returns the name of the specified output. More...
 
const struct RTI_RoutingServiceStreamInfoRTI_RoutingServiceOutput_get_stream_info (RTI_RoutingServiceOutput *self)
 Returns the type information associated with the specified Output. The type information refers to the format of the stream that this Output's write operation expects to receive from the processor of the route. More...
 
DDS_Boolean RTI_RoutingServiceOutput_write (RTI_RoutingServiceOutput *self, const RTI_RoutingServiceSample *sample_array, const RTI_RoutingServiceSampleInfo *sample_info_array, int *array_length)
 Writes a list of data and information samples. More...
 
DDS_Boolean RTI_RoutingServiceOutput_write_sample (RTI_RoutingServiceOutput *self, const RTI_RoutingServiceSample data, const RTI_RoutingServiceSampleInfo info)
 Writes a single sample, optionally with metatada indicated by an info sample. More...
 
int RTI_RoutingServiceRoute_get_input_count (RTI_RoutingServiceRoute *self)
 Returns the number of inputs associated with this Route. More...
 
DDS_Boolean RTI_RoutingServiceRoute_is_input_enabled (RTI_RoutingServiceRoute *self, int index)
 Checks whether the Input with the specified index is enabled. More...
 
RTI_RoutingServiceInput * RTI_RoutingServiceRoute_get_input_at (RTI_RoutingServiceRoute *self, int index)
 Returns the Input at the specified index. More...
 
RTI_RoutingServiceInput * RTI_RoutingServiceRoute_lookup_input_by_name (RTI_RoutingServiceRoute *self, const char *input_name)
 Looks up the specified Input by its configuration name. More...
 
int RTI_RoutingServiceRoute_get_output_count (RTI_RoutingServiceRoute *self)
 Returns the number of outputs associated with this Route. More...
 
DDS_Boolean RTI_RoutingServiceRoute_is_output_enabled (RTI_RoutingServiceRoute *self, int index)
 Checks whether the Output at the specified index is enabled. More...
 
RTI_RoutingServiceOutput * RTI_RoutingServiceRoute_get_output_at (RTI_RoutingServiceRoute *self, int index)
 Returns the Output at the specified index. More...
 
RTI_RoutingServiceOutput * RTI_RoutingServiceRoute_lookup_output_by_name (RTI_RoutingServiceRoute *self, const char *output_name)
 Looks up the specified Output by its configuration name. More...
 
void RTI_RoutingServiceRoute_wakeup_route (RTI_RoutingServiceRoute *route)
 Sends a wakeup event to the specified Route. This operation can be safely called from any thread context. More...
 
void RTI_RoutingServiceRoute_get_period (RTI_RoutingServiceRoute *self, struct DDS_Duration_t *period)
 Get the current period of the periodic event for this Route. More...
 
void RTI_RoutingServiceRoute_set_period (RTI_RoutingServiceRoute *self, const struct DDS_Duration_t *period)
 Changes the periodic event period for this route. More...
 
RTI_RoutingServiceInput * RTI_RoutingServiceRoute_get_first_input (RTI_RoutingServiceRoute *self)
 Returns the first enabled Input in this route. More...
 
RTI_RoutingServiceInput * RTI_RoutingServiceRoute_get_next_input (RTI_RoutingServiceRoute *self, RTI_RoutingServiceInput *prev_input)
 Returns the next enabled Input sibling to the specified input. More...
 
RTI_RoutingServiceOutput * RTI_RoutingServiceRoute_get_first_output (RTI_RoutingServiceRoute *self)
 Returns the first enabled output in this route. More...
 
RTI_RoutingServiceOutput * RTI_RoutingServiceRoute_get_next_output (RTI_RoutingServiceRoute *self, RTI_RoutingServiceOutput *prev_output)
 Returns the next enabled Output sibling to the specified output. More...
 
const char * RTI_RoutingServiceRoute_get_full_name (RTI_RoutingServiceRoute *self)
 Returns the fully-qualified name of this Route, derived from the XML configuration. More...
 
RTI_RoutingServiceRouteEventKind RTI_RoutingServiceRouteEvent_get_kind (RTI_RoutingServiceRouteEvent *self)
 Returns the kind of this RouteEvent. More...
 
RTI_RoutingServiceRoute * RTI_RoutingServiceRouteEvent_get_route (RTI_RoutingServiceRouteEvent *self)
 Returns the Route that triggered the event. More...
 
void * RTI_RoutingServiceRouteEvent_get_event_data (RTI_RoutingServiceRouteEvent *self)
 Returns the data associated with the event. More...
 
void * RTI_RoutingServiceRouteEvent_get_affected_entity (RTI_RoutingServiceRouteEvent *self)
 Returns the entity that is directly affected by the event. More...
 

Detailed Description

RTI Routing Service Processor API.