Sirikata::ODP::Endpoint Class Reference

A fully qualified ODP endpoint: SpaceID, ObjectReference, and PortID. More...

#include <Defs.hpp>

Inheritance diagram for Sirikata::ODP::Endpoint:

Collaboration diagram for Sirikata::ODP::Endpoint:

List of all members.

Public Types
typedef Sirikata::XDP::Endpoint < ObjectReference >	EndpointBase
typedef std::tr1::function < void(const Endpoint &src, const Endpoint &dst, MemoryReference)>	MessageHandler
	Function signature for an ODP message handler.
Public Member Functions
	Endpoint (const SpaceID &space, const ObjectReference &obj, const PortID &port)
	Endpoint (const SpaceObjectReference &space_obj, const PortID &port)
const ObjectReference &	object () const
SpaceObjectReference	spaceObject () const
Static Public Member Functions
static const Endpoint &	null ()
	Get a null Endpoint, i.e.
static const Endpoint &	any ()
	Get an Endpoint that matches any other Endpoint, i.e.
Private Member Functions
	Endpoint ()

---

Detailed Description

A fully qualified ODP endpoint: SpaceID, ObjectReference, and PortID.

Note that this does not have to be bound to unique values. For instance, to specify coverage of all ports, PortID::any() could be used. However, depending on context, the use of non-specific values may be invalid.

---

Member Typedef Documentation

typedef Sirikata::XDP::Endpoint<ObjectReference> Sirikata::ODP::Endpoint::EndpointBase

typedef std::tr1::function<void(const Endpoint& src, const Endpoint& dst, MemoryReference)> Sirikata::ODP::Endpoint::MessageHandler

Function signature for an ODP message handler.

Takes a message header, containing the ODP routing information, and a MemoryReference containing the payload.

---

Constructor & Destructor Documentation

Sirikata::ODP::Endpoint::Endpoint	(	const SpaceID &	space,
		const ObjectReference &	obj,
		const PortID &	port
	)		[inline]

Reimplemented from Sirikata::XDP::Endpoint< ObjectReference >.

Sirikata::ODP::Endpoint::Endpoint	(	const SpaceObjectReference &	space_obj,
		const PortID &	port
	)		[inline]

Sirikata::ODP::Endpoint::Endpoint

(

)

[private]

Reimplemented from Sirikata::XDP::Endpoint< ObjectReference >.

---

Member Function Documentation

static const Endpoint& Sirikata::ODP::Endpoint::any

(

)

[inline, static]

Get an Endpoint that matches any other Endpoint, i.e.

where each component is its respective any() value.

References Sirikata::XDP::PortID::any(), Sirikata::ObjectReference::any(), and Sirikata::SpaceID::any().

static const Endpoint& Sirikata::ODP::Endpoint::null

(

)

[inline, static]

Get a null Endpoint, i.e.

one where each component is null.

References Sirikata::XDP::PortID::null(), Sirikata::ObjectReference::null(), and Sirikata::SpaceID::null().

const ObjectReference& Sirikata::ODP::Endpoint::object

(

)

const [inline]

Referenced by Sirikata::Server::delegateODPPortSend(), Sirikata::HostedObject::delegateODPPortSend(), Sirikata::JS::EmersonScript::iHandleScriptCommUnreliable(), and Sirikata::SST::BaseDatagramLayer< SpaceObjectReference >::receiveMessage().

SpaceObjectReference Sirikata::ODP::Endpoint::spaceObject

(

)

const [inline]

Referenced by Sirikata::ODP::DelegateService::deallocatePort(), and Sirikata::ODP::DelegateService::deliver().

---

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

• libcore/include/sirikata/core/odp/Defs.hpp