#include <Service.hpp>

Inherits dds::core::Reference< RoutingServiceImpl >.

Public Member Functions
	Service (const ServiceProperty &property)
	Creates a RTI Routing Service instance. More...

template<typename HookFunc >
	Service (const ServiceProperty &property, HookFunc &shutdown_hook)
	Creates a RTI Routing Service instance. More...

void	start ()
	Starts RTI Routing Service. More...

void	stop ()
	Stops RTI Routing Service. More...

void	attach_adapter_plugin (rti::routing::adapter::AdapterPlugin *adapter_plugin, const std::string &plugin_name)
	Attaches an Adapter plugin to be used by RTI Routing Service when it is started. More...

void	attach_processor_plugin (rti::routing::processor::ProcessorPlugin *processor_plugin, const std::string &plugin_name)
	Attaches a Processor plugin to be used by RTI Routing Service when it is started. More...

void	attach_transformation_plugin (rti::routing::transf::TransformationPlugin *transformation_plugin, const std::string &plugin_name)
	Attaches a Transformation plugin to be used by RTI Routing Service when it is started. More...

CommandReply	execute_command (const CommandRequest &request)
	Executes an Administration command on this service. More...

CommandReply &	execute_command (CommandReply &reply, const CommandRequest &request)
	Executes an Administration command on this service. More...

Static Public Member Functions
static void	finalize_globals ()

Detailed Description

The RTI Routing Service.

Constructor & Destructor Documentation

◆ Service() [1/2]

rti::routing::Service::Service ( const ServiceProperty & property )

inlineexplicit

Creates a RTI Routing Service instance.

Parameters

property <<in>> The property to configure RTI Routing Service instance.

Multi-threading safety:: On non-Linux, non-Windows systems (i.e. VxWorks): UNSAFE for multiple threads to simultaneously make the FIRST call to any of the Service constructors. Subsequent calls are thread safe. On Windows and Linux systems, these calls are thread-safe.

◆ Service() [2/2]

template<typename HookFunc >

rti::routing::Service::Service	(	const ServiceProperty &	property,
		HookFunc &	shutdown_hook
	)

inline

Creates a RTI Routing Service instance.

A callable shutdown hook can optionally be provided to handle the shutdown command received through remote administration. Upon reception of this command, RTI Routing Service will notify the installed hook.

The following example shows simple implementation of a shutdown hook that sets a boolean flag to true when invoked:

// Hook implementation
struct FlagShutdownHook {
public:
    FlagShutdownHook(bool& the_flag) : flag(the_flag) {
        flag = false;
    }
    void operator()() {
        flag = true;
    }
 
    bool& flag;
};
 
// Instantiate service with hook
bool my_flag;
FlagShutdownHook my_hook(my_flag)
rti::routing::Service routing_service(
      property,
      my_hook);
...

Parameters

[in]	property	The property to configure RTI Routing Service instance.
[in]	shutdown_hook	Callable object to handle the shutdown command. The expected type is a void operator()() (C++11 equivalent is std::function<void()>)

Multi-threading safety:: On non-Linux, non-Windows systems (i.e. VxWorks): UNSAFE for multiple threads to simultaneously make the FIRST call to any of the Service constructors. Subsequent calls are thread safe. On Windows and Linux systems, these calls are thread-safe.

Member Function Documentation

◆ start()

void rti::routing::Service::start ( )

inline

Starts RTI Routing Service.

This is a non-blocking operation. RTI Routing Service will create its own set of threads to perform its tasks.

◆ stop()

void rti::routing::Service::stop ( )

inline

Stops RTI Routing Service.

This operation will bloc the instance is fully stopped.

◆ attach_adapter_plugin()

void rti::routing::Service::attach_adapter_plugin	(	rti::routing::adapter::AdapterPlugin *	adapter_plugin,
		const std::string &	plugin_name
	)

inline

Attaches an Adapter plugin to be used by RTI Routing Service when it is started.

By using this function an adapter can be statically compiled, created in your application and have the service load it, instead of registering a shared library and a create function in the configuration.

The name passed in this function is the name that has to be used in the configuration to instantiate connections from the plugin.

Example:

rti::routing::RoutingService service(property);
 
service.attach_adapter_plugin(myAdapter, "MyAdapter");
 
service.start();
...

And our configuration would look like this:

<dds>
 <!-- No need to register the plugin in
      <plugin_library><adapter_plugin>
 -->
 <routing_service name="example">
  <domain_route name="myadapter_to_dds">
 
    <connection name="MyConnection" plugin_name="MyAdapter">
       ...
    </connection>
 
    ...
  </domain_route>
 </routing_service>
</dds>

This function can be called as many times as desired to attach several plugins.

Precondition: Routing Service must not be started

Parameters

adapter_plugin	<<in>> The adapter plugin object to be attached. The object shall remain alive during the execution of the service. Once the plugin is attached, the memory is owned by RTI Routing Service and will delete it upon service stop.
plugin_name	<<in>> The name used for this plugin in the <connection> tag in the configuration.

◆ attach_processor_plugin()

void rti::routing::Service::attach_processor_plugin	(	rti::routing::processor::ProcessorPlugin *	processor_plugin,
		const std::string &	plugin_name
	)

inline

Attaches a Processor plugin to be used by RTI Routing Service when it is started.

See also: attach_adapter_plugin

◆ attach_transformation_plugin()

void rti::routing::Service::attach_transformation_plugin	(	rti::routing::transf::TransformationPlugin *	transformation_plugin,
		const std::string &	plugin_name
	)

inline

Attaches a Transformation plugin to be used by RTI Routing Service when it is started.

See also: attach_adapter_plugin

◆ execute_command() [1/2]

CommandReply rti::routing::Service::execute_command ( const CommandRequest & request )

inline

Executes an Administration command on this service.

This operation directly executes the specified request in this service as if it was directly received from an administration requester.

The request can represent any of the available administration operations as documented in the Administration chapter in the user's manual. This operation gives you an alternative way to control the service using the same remote administration interface but allowing you to call the operation directly.

This operation can also throw an exception if an internal error occurs.

Example:

 using namespace rti::routing;
 using namespace RTI::Service;
 using namespace RTI::Service::Admin;
 
 // Instantiate a RoutingServicee
 RoutingService service(...);
 
 // Prepare a request for any command, for example stop the service
 CommandRequest request;
 request.action(CommandActionKind::UPDATE_ACTION);
 request.resource_identifier("/routing_services/MyRouter");
 dds::topic::topic_type_support<EntityState>::to_cdr_buffer(
         reinterpret_cast<std::vector<char> &>(request.octet_body()),
         EntityState(EntityStateKind::DISABLED));
// Execute and check result
CommandReply reply = service.execute_command(request);
if (reply.retcode().underlying() != CommandReplyRetcode::OK_RETCODE) {
    Logger.instance().error(
            std::string("Command returned: ") + reply.string_body());
    //handle
    ...
}

Parameters

[in] request Representation of the command to be executed

Returns: The reply with the result of the command execution.

◆ execute_command() [2/2]

CommandReply & rti::routing::Service::execute_command	(	CommandReply &	reply,
		const CommandRequest &	request
	)

inline

Executes an Administration command on this service.

Similar to execute_command(const CommandRequest& request) except the caller provides the CommandReply object.

Parameters

[out]	reply	Representation of the reply containing the result of the operation
[in]	request	Representation of the command to be executed

Returns: A reference to the same reply object provided as a parameter

◆ finalize_globals()

static void rti::routing::Service::finalize_globals ( )

inlinestatic

[DEPRECATED] Calling this function at the end of the application is no longer necessary. It will be removed in future versions.

References rti::routing::Logger::warn().

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Service() [1/2]

◆ Service() [2/2]

Member Function Documentation

◆ start()

◆ stop()

◆ attach_adapter_plugin()

◆ attach_processor_plugin()

◆ attach_transformation_plugin()

◆ execute_command() [1/2]

◆ execute_command() [2/2]

◆ finalize_globals()