Sirikata
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions
Sirikata::OHDP::Endpoint Class Reference

A fully qualified OHDP endpoint: SpaceID, NodeID, and PortID. More...

#include <Defs.hpp>

Inheritance diagram for Sirikata::OHDP::Endpoint:
Collaboration diagram for Sirikata::OHDP::Endpoint:

List of all members.

Public Types

typedef
Sirikata::XDP::Endpoint
< NodeID
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 NodeID &node, const PortID &port)
 Endpoint (const SpaceNodeID &spacenode, const PortID &port)
const NodeIDnode () const

Static Public Member Functions

static const Endpointnull ()
 Get a null Endpoint, i.e.
static const Endpointany ()
 Get an Endpoint that matches any other Endpoint, i.e.

Private Member Functions

 Endpoint ()

Detailed Description

A fully qualified OHDP endpoint: SpaceID, NodeID, and PortID.

The meaning of NodeID will depend on where it's used: it will map to individual space servers on the object host and to individual object hosts on the space server. 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 std::tr1::function<void(const Endpoint& src, const Endpoint& dst, MemoryReference)> Sirikata::OHDP::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::OHDP::Endpoint::Endpoint ( const SpaceID space,
const NodeID node,
const PortID port 
) [inline]
Sirikata::OHDP::Endpoint::Endpoint ( const SpaceNodeID spacenode,
const PortID port 
) [inline]
Sirikata::OHDP::Endpoint::Endpoint ( ) [private]

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


Member Function Documentation

static const Endpoint& Sirikata::OHDP::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::OHDP::NodeID::any(), and Sirikata::SpaceID::any().

const NodeID& Sirikata::OHDP::Endpoint::node ( ) const [inline]
static const Endpoint& Sirikata::OHDP::Endpoint::null ( ) [inline, static]

Get a null Endpoint, i.e.

one where each component is null.

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


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