TNL::NetObjectRPCEvent class Reference

TNL::NetObjectRPCEvent Class Reference

#include <tnlNetObject.h>

Inheritance diagram for TNL::NetObjectRPCEvent:

Detailed Description

Event class for handling RPC method invocations on NetObjects.

When an RPC method is called on the server side NetObject, it is broadcast to all connections that have that NetObject in scope. When an RPC method is called on a ghost (on the client), it is handled by the originating server object.

Public Member Functions

NetObjectRPCEvent (NetObject *destObject, RPCGuaranteeType type, NetObjectRPCDirection dir)

Constructor - initializes the base class's data.

void pack (EventConnection *ps, BitStream *bstream)

Pack is called on the origin side of the connection to write an event's data into a packet.

void unpack (EventConnection *ps, BitStream *bstream)

Unpack is called on the destination side of the connection to read an event's data out of a packet.

void process (EventConnection *ps)

Process is called to process the event data when it has been unpacked.

Data Fields

SafePtr< NetObject > mDestObject

Destination object of the RPC invocation.

NetObjectRPCDirection mRPCDirection

Direction this RPC should travel.

Constructor & Destructor Documentation

TNL::NetObjectRPCEvent::NetObjectRPCEvent ( NetObject * destObject,

RPCGuaranteeType type,

NetObjectRPCDirection dir

) [inline]

Constructor - initializes the base class's data.

Member Function Documentation

void TNL::NetObjectRPCEvent::pack ( EventConnection * ps,

BitStream * bstream

) [virtual]

Pack is called on the origin side of the connection to write an event's data into a packet.

Reimplemented from TNL::RPCEvent.

void TNL::NetObjectRPCEvent::unpack ( EventConnection * ps,

BitStream * bstream

) [virtual]

Unpack is called on the destination side of the connection to read an event's data out of a packet.

Reimplemented from TNL::RPCEvent.

void TNL::NetObjectRPCEvent::process ( EventConnection * ps ) [virtual]

Process is called to process the event data when it has been unpacked.
For a guaranteed, ordered event, process is called only once all prior events have been received and processed. For unguaranteed events, process is called immediately after unpack.
Reimplemented from TNL::RPCEvent.

Field Documentation

SafePtr<NetObject> TNL::NetObjectRPCEvent::mDestObject

Destination object of the RPC invocation.

NetObjectRPCDirection TNL::NetObjectRPCEvent::mRPCDirection

Direction this RPC should travel.