A reference to an object in a space. More...

#include <SpaceID.hpp>

Inheritance diagram for Sirikata::SpaceID:

Collaboration diagram for Sirikata::SpaceID:

Classes
class	Hasher
Public Types
enum	{ static_size = UUID::static_size }
Public Member Functions
	SpaceID ()
	SpaceID (const UUID &id)
	SpaceID (const String &str)
	SpaceID (const UUID::Data &data)
UUID::Data	toRawBytes () const
String	toRawHexData () const
bool	isNull () const
String	toString () const
unsigned int	hash () const
const UUID &	getObjectUUID () const
	Get the UUID of the object referred to.
UUID	getAsUUID () const
	Get this object reference in the form of an UUID.
bool	operator== (const SpaceID &rhs) const
bool	operator< (const SpaceID &rhs) const
bool	matches (const SpaceID &rhs) const
Static Public Member Functions
static const SpaceID &	null ()
static const SpaceID &	any ()
	Get a reserved SpaceID which is a sentinal to match any other SpaceID.
Private Attributes
UUID	mID

Detailed Description

A reference to an object in a space.

This can be used as an address to send a message to an object via a space. SpaceIDs are specific to spaces, i.e. they are not guaranteed to work in spaces other than the one they originated in.

Member Enumeration Documentation

anonymous enum

Enumerator:

static_size

Constructor & Destructor Documentation

Sirikata::SpaceID::SpaceID ( )

Sirikata::SpaceID::SpaceID ( const UUID & id ) [explicit]

Sirikata::SpaceID::SpaceID ( const String & str ) [explicit]

Sirikata::SpaceID::SpaceID ( const UUID::Data & data ) [explicit]

Member Function Documentation

static const SpaceID& Sirikata::SpaceID::any ( ) [inline, static]

Get a reserved SpaceID which is a sentinal to match any other SpaceID.

References Sirikata::UUID::max().

Referenced by Sirikata::OHDP::Endpoint::any(), Sirikata::ODP::Endpoint::any(), Sirikata::HostedObject::createDelegateODPPort(), and Sirikata::XDP::DelegatePort< EndpointType, DelegateServiceType, PortType >::deliver().

UUID Sirikata::SpaceID::getAsUUID ( ) const [inline]

Get this object reference in the form of an UUID.

This value is space-specific and used in contexts where objects need to be addressed by some form of UUID, e.g. for message routing. Note the contrast with getObjectUUID().

const UUID& Sirikata::SpaceID::getObjectUUID ( ) const [inline]

Get the UUID of the object referred to.

This is not necessarily space-specific, it is just the value used to construct this reference. Note the contrast with getAsUUID().

unsigned int Sirikata::SpaceID::hash ( ) const [inline]

Referenced by Sirikata::OHDP::SpaceNodeID::Hasher::operator()(), and Sirikata::SpaceID::Hasher::operator()().

bool Sirikata::SpaceID::isNull ( ) const [inline]

bool Sirikata::SpaceID::matches ( const SpaceID & rhs ) const [inline]

Referenced by Sirikata::XDP::Endpoint< NodeID >::matches().

static const SpaceID& Sirikata::SpaceID::null ( ) [inline, static]

References Sirikata::UUID::null().

Referenced by Sirikata::OHDP::Service::bindOHDPPort(), Sirikata::HostedObject::connect(), Sirikata::HostedObject::createDelegateODPPort(), Sirikata::Forwarder::dispatchMessage(), Sirikata::Server::handleSingleObjectHostMessageRouting(), Sirikata::OHDP::SpaceNodeID::null(), Sirikata::SpaceObjectReference::null(), Sirikata::OHDP::Endpoint::null(), Sirikata::ODP::Endpoint::null(), Sirikata::ObjectHostConnectionManager::ObjectHostConnectionManager(), Sirikata::Server::Server(), Sirikata::Forwarder::setODPService(), Sirikata::OHDP::SpaceNodeID::SpaceNodeID(), and Sirikata::SpaceObjectReference::SpaceObjectReference().