RobotRaconteur::InvalidEndpointException Class Reference

Exception thrown when an attempt is made to send a message to an invalid endpoint. More...

#include <Error.h>

Inheritance diagram for RobotRaconteur::InvalidEndpointException:

Public Member Functions
	InvalidEndpointException (const std::string &message, std::string sub_name="", const boost::intrusive_ptr< RRValue > &param_=boost::intrusive_ptr< RRValue >())
	Construct an InvalidEndpointException.
virtual std::string	ToString ()
	Returns a string representing the exception.

Public Attributes
MessageErrorType	ErrorCode
	Predefined error code.
std::string	Error
	Name of the error.
std::string	Message
	Message to pass to the user.
std::string	ErrorSubName
	An optional sub_name to further categorize the exception.
boost::intrusive_ptr< RRValue >	ErrorParam
	An optional parameter.

Detailed Description

Exception thrown when an attempt is made to send a message to an invalid endpoint.

Transports between two nodes terminate with a pair of endpoints, one in each node. If the client, service, service endpoint, or transport is destroyed, the endpoint will be deleted. This exception is thrown if the target endpoint is no longer available.

Error code MessageErrorType_InvalidEndpoint (5)

Constructor & Destructor Documentation

InvalidEndpointException()

RobotRaconteur::InvalidEndpointException::InvalidEndpointException	(	const std::string &	message,
		std::string	sub_name = "",
		const boost::intrusive_ptr< RRValue > &	param_ = boost::intrusive_ptr< RRValue >() )

Construct an InvalidEndpointException.

Parameters

message	Message for the user
sub_name	Optional error sub_name
param_	Optional error param

Member Function Documentation

ToString()

virtual std::string RobotRaconteur::RobotRaconteurException::ToString ( )

virtualinherited

Returns a string representing the exception.

Returns

std::string

Member Data Documentation

Error

std::string RobotRaconteur::RobotRaconteurException::Error

inherited

Name of the error.

Name corresponding to predefined error code, or a user defined error type

ErrorCode

MessageErrorType RobotRaconteur::RobotRaconteurException::ErrorCode

inherited

Predefined error code.

Error code that specifies the type of error

ErrorParam

boost::intrusive_ptr<RRValue> RobotRaconteur::RobotRaconteurException::ErrorParam

inherited

An optional parameter.

Use this placeholder if data needs to be passed with the exception

ErrorSubName

std::string RobotRaconteur::RobotRaconteurException::ErrorSubName

inherited

An optional sub_name to further categorize the exception.

The sub_name should follow the Robot Raconteur naming rules. It should either be a single name or a fully qualified name using service definition naming rules

Message

std::string RobotRaconteur::RobotRaconteurException::Message

inherited

Message to pass to the user.

Human readable message to pass to the user

---

The documentation for this class was generated from the following file:

• /builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/Error.h