Remote Procedure Call

Remote Procedure call (RPC) communication pattern. More...

Modules
	Client-side API
	Part of the RPC API that relates to the client.
	Server-side API
	Part of the RPC API that relates to the Server and ServiceEndpoint.

Classes
class	dds::rpc::RemoteUnknownOperationError
	Thrown when a Client calls an operation that doesn't exist in the Service. More...
class	dds::rpc::RemoteUnsupportedOperationError
	Thrown when a Client calls an operation that is not supported by the Service. More...
class	dds::rpc::RemoteInvalidArgumentError
	Thrown when a Client provides an invalid argument to a Service operation. More...
class	dds::rpc::RemoteOutOfResourcesError
	Thrown when the Service runs out of resources to fulfill a Client's operation. More...
class	dds::rpc::RemoteUnknownExceptionError
	Thrown when an unknown exception occurs in the Service. More...
class	rpc_example::RobotControl
	The synchronous interface generated from the RobotControl IDL service. More...
class	rpc_example::RobotControlAsync
	The asynchronous interface derived from the RobotControl service. More...

Detailed Description

Remote Procedure call (RPC) communication pattern.

With RPC you can write client and service applications that make and process function calls according to interfaces defined in IDL. The clients and the services communicate using DDS topics.

Warning

This feature is experimental and subject to change in future releases. It is included in this release to gather customer interest and feedback. For this reason, do not deploy any applications using Remote Procedure Calls in production. For support, you may contact suppo.nosp@m.rt@r.nosp@m.ti.co.nosp@m.m.

Note

To get started follow the RPC Tutorial.

The classes involved in RPC include types generated by rtiddsgen and supporting types in the dds::rpc and rti::rpc namespaces. This API reference assumes that an example IDL service interface is defined as follows:

exception WalkError {
    string<32> message;
};
 
exception TooFastError {
};
 
@final
struct Coordinates {
    int32 x;
    int32 y;
};
 
@service
interface RobotControl {
    Coordinates walk_to(Coordinates destination, float speed)
            raises(WalkError, TooFastError);
 
    float get_speed();
 
    attribute string<128> name;
};

From this IDL the following types are generated:

• rpc_example::RobotControl (a pure-virtual abstract class)
• rpc_example::RobotControlAsync (a pure-virtual abstract class)
• rpc_example::RobotControlService (an instantiation of dds::rpc::ServiceEndpoint)
• rpc_example::RobotControlClient (derived from dds::rpc::ClientEndpoint)

In addition, the class dds::rpc::Server provides the execution context for one or more services.

See also

RPC Tutorial