Object

The root base class for all proxies. More...

#include <unity/scopes/Object.h>

Inheritance diagram for unity::scopes::Object:
Inheritance graph
[legend]

Public Member Functions

virtual std::string endpoint ()=0
 Returns the endpoint this proxy connects to. More...
 
virtual std::string identity ()=0
 Returns the identity of the target object of this proxy. More...
 
virtual std::string target_category ()=0
 Returns the category of the target object of this proxy. More...
 
virtual int64_t timeout ()=0
 Returns the timeout in milliseconds if this proxy is a twoway proxy. More...
 
virtual std::string to_string ()=0
 Converts a proxy into its string representation. More...
 

Detailed Description

The root base class for all proxies.

Member Function Documentation

virtual std::string unity::scopes::Object::endpoint ( )
pure virtual

Returns the endpoint this proxy connects to.

Returns
The endpoint of the proxy.
virtual std::string unity::scopes::Object::identity ( )
pure virtual

Returns the identity of the target object of this proxy.

Returns
The identity of the target of the proxy.
virtual std::string unity::scopes::Object::target_category ( )
pure virtual

Returns the category of the target object of this proxy.

Returns
The category of the target of the proxy.
virtual int64_t unity::scopes::Object::timeout ( )
pure virtual

Returns the timeout in milliseconds if this proxy is a twoway proxy.

For oneway proxies and twoway proxies without a timeout, the return value is -1.

Returns
The timeout value in milliseconds (-1 if none or timeout does not apply).
virtual std::string unity::scopes::Object::to_string ( )
pure virtual

Converts a proxy into its string representation.

A proxy string can be converted back into a proxy by calling Runtime::string_to_proxy().

Returns
The string representation of the proxy.