acedia::ActorRef Class Reference

ActorRef describes a reference (or link) to a local actor or proxy. More...

#include <actorref.hpp>

List of all members.

Public Member Functions

void send (const Message &msg)
 Send a message to the referenced actor.
void linkExited (boost::int32_t why, const ActorRef &who) throw ()
 Told the referenced actor that who exited with reason why.
bool isValid () const
 Check if this instance points to a local actor or proxy.
boost::uint32_t actorId () const
 Get the id of the referenced actor.
boost::uint32_t realActorId () const
 Get the real actor id. This call is equal to actorId() on local actors but returns the id of the remote actor (and not the id the proxy actor) if isFarRef() == true.
bool isFarRef () const
 Check if this instance points to a remote actor.

Friends

void link (ActorRef, ActorRef)
 Link actor1 and actor2.

Detailed Description

ActorRef describes a reference (or link) to a local actor or proxy.

Note:
ActorRef is not thread safe. Use always call-by-value if you pass an ActorRef to a function or method that might run in another thread.
Examples:

networkPong.cpp, pong.cpp, and timedPong.cpp.

Definition at line 54 of file actorref.hpp.


Member Function Documentation

bool acedia::ActorRef::isValid (  )  const

Check if this instance points to a local actor or proxy.

A default constructed ActorRef returns false.

Definition at line 89 of file actorref.cpp.


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

Generated by  doxygen 1.6.2