RobotRaconteur::ConnectionException Class Reference

Exception thrown when connection to remote node fails. More...

Inheritance diagram for RobotRaconteur::ConnectionException:

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

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

Detailed Description

Exception thrown when connection to remote node fails.

This exception is thrown if a connection cannot be created, the connection fails, or the connection has been closed.

Error code MessageErrorType_ConnectionError (1)

Constructor & Destructor Documentation

ConnectionException()

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

Construct a ConnectionException.

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:

• /home/runner/work/robotraconteur/robotraconteur/robotraconteur/RobotRaconteurCore/include/RobotRaconteur/Error.h