VOS Namespace Reference

Virtual Object System core library. More...

Compounds

class AsyncConnect
Connects to a remote site sort of asynchronously. More...
class ChildChangeListener
Interface to be called when a listened-to object has some change to its child list. More...
class DoNothingListener
Trivial listener implementation that does nothing. More...
class EnqueueOutgoing
A message filter that enqueues all outgoing messages except for anti-spoof checking and errors. More...
class LocalMetaObject
A local object which is extensible using the MetaObject architechture. More...
class LocalOnlyAccessControl
Access control policy that always says no. More...
class LocalSite
A site which is local to your application. More...
struct LocalSite::CallbackInfo
class LocalSite::CallbackListener
Timer callback listener type. More...
class LocalSite::PortBindingError
struct LocalSite::SiteTableEntry
struct LocalSite::ValidationEntry
class LocalSocketSite
A local site implemented using TCP sockets. More...
class LocalSocketSite::PortBindingError
An exception class thrown when there is an error initializing the listening socket. More...
class LocalSocketSite::SSLError
An exception class thrown when there is an error initializing SSL. More...
class LocalVobject
This class contains the code to respond to messages from remote objects inquiring about the Vobject's state. More...
class Log
The logging class. More...
class Log::StrCmp
class Message
This class handles storing, generating and parsing of the messages that are sent between virtual objects. More...
struct Message::Field
A key-value field pair used to store the fields of the message. More...
class Message::NoSuchFieldError
Thrown when getField() is passed an out-of-range parameter. More...
class MessageBlock
A message block is a list of messages which have been bundled together into a single block. More...
class MessageContext
A message substitution context. More...
class MessageContext::NoSuchParameterError
class MessageFilter
A message filter can be attached to any site to filter the messages passing through that site. More...
class MetaObject
This class is responsible for managing a group of object extensions under a single logical Vobject. More...
class msgFlexLexer
class NoAccessControl
Access control policy that always says yes. More...
class NotifyEvent
class ObjectExciseListener
Interface by which an application can be notified that an object wants to be excised. More...
class OutgoingLock
A message filter that denies (and drops) all outgoing messages except for anti-spoof checking and errors. More...
class ParentChangeListener
Interface to be called when a listened-to object has some change to its parent set. More...
struct parse_state_t
Stores some state information needed between calls to the Message parser, when a message has only been partially parsed. More...
class ReadOnlyAccessControl
Access control policy that allows requests for information (reads) and denies all changes (writes). More...
class RefCounted
This is a simple base class for reference counting objects. More...
class RemoteMetaObject
A RemoteMetaObject is a Remote Vobject supporting the MetaObject extension architechture, allowing you to use meta_cast to select between available C++ interfaces supported by the Vobject type. More...
class RemoteSite
This class manages a connection to a remote site and the objects bound to that site. More...
class RemoteSite::NoLocalPeerError
class RemoteSite::SiteConnectionError
class RemoteSocketSite
This class manages a connection to a remote site and the objects bound to that site. More...
class RemoteStreamSite
A simulated remote site using a file for input instead of a network socket. More...
class RemoteVobject
This class allows you to access remotely Vobjects as if they were local. More...
class RewriteTo
A message filter that rewrites the To: field of messages. More...
class Site
A site is the root of any collection of Vobjects. More...
class Site::NoSuchMessageBlockError
class SiteAccessControl
Additional policy interface specificly for Sites. More...
class TypeChangeListener
Interface to be called when a listened-to object has some change to its type set. More...
class URL
A class implementing basic handling of Uniform Resource Locator (URL) expressions. More...
class URL::BadURLError
class Vobject
This is the abstract class that defines the basic API common to all virtual objects. More...
class Vobject::AccessControlError
class Vobject::MessageQueueEmptyError
An exception class thrown when the user attempts to read from the receiving queue and that queue is empty. More...
class Vobject::NoSuchObjectError
An exception class thrown when an object lookup fails. More...
class Vobject::NoSuchSiteError
An exception class thrown when a site lookup fails. More...
class Vobject::ParentChildRelation
This structure expresses the relation between a parent vobject and a vobject which is a child of that parent. More...
class Vobject::ParentChildRelation::Cmp
This class is used internally to compare two ParentChildRelation structures to see if they represent the same relationship. More...
class Vobject::RemoteError
An exception class thrown when a remote action fails. More...
class Vobject::TimeoutError
An exception class thrown when an expected reply didn't arrive in the alloted time. More...
class VobjectAccessControl
This is the base class for Vobject access control policies. More...
struct VobjectAccessControl::AssignAC
class VobjectEvent
This class describes an event changing the state of a Vobject. More...
class VobjectImplementation
A base implementation class for virtual objects. More...
class VobjectImplementation::Dispatch
class VobjectImplementation::DispatchTemplate
class VobjectNotifyEvent
class vRef
This is a "smart pointer" wrapper class around any RefCounted object. More...

Typedefs

typedef VobjectAccessControl *(* VobjectAccessControlFactory )(const string &type, LocalVobject *lv)
typedef MetaObject *(* metaobject_extender_t )(MetaObject *superobject, const string &type)

Functions

string * xmlFormatting (const string &type, const string &to, const string &from, const string &method, const string &nonce, const string &dependsOn, double mtime, const deque< Message::Field > &fields, bool withLength)
Converts a message into an XML format message.
int msgparse (void *lexer)
Bison driver for XML parser.
int msglex (char **lvalp, void *lexer)
Bison callback for XML parser.
void msgerror (char *blah)
Bison callback for XML parser.
VOS_API double getTimer ()
Get a timer time in seconds.
VOS_API double getRealTime ()
Get the current time in seconds from the underlying operating system call.

Detailed Description
Virtual Object System core library.
Typedef Documentation

typedef MetaObject*(* VOS::metaobject_extender_t)(MetaObject* superobject, const string& type)

Definition at line 39 of file localsite.hh.

typedef VobjectAccessControl*(* VOS::VobjectAccessControlFactory)(const string& type, LocalVobject* lv)

Definition at line 44 of file accesscontrol.hh.

Function Documentation

VOS_API double getRealTime ( )

Get the current time in seconds from the underlying operating system call.

Referenced by VOS::AsyncConnect::connect(), RemoteSearch::doSearch(), getTimer(), LocalSearch::handleSearch(), ExtrapolatedProperty::now(), and RemoteCOD::readCOD().

VOS_API double getTimer ( )

Get a timer time in seconds.
This is based on the "real" time, but it is guaranteed to always increase between calls. This is necessary to smooth over some odd behavior in certain operating system / hardware combinations where the clock can actually run backwards over short, subsecond periods of time!
Definition at line 134 of file timer.cc.
Referenced by VOS::LocalSocketSite::calculateTimeout(), LocalSite::doCallbacks(), ExtrapolatedProperty::now(), LocalSite::runSchedule(), and LocalSite::scheduleMessageBlock().

void msgerror ( char * blah )

Bison callback for XML parser.

For internal use only.

int msglex ( char ** lvalp,

void * lexer

)

Bison callback for XML parser.

For internal use only.

int msgparse ( void * lexer )

Bison driver for XML parser.

For internal use only.

Referenced by VOS::MessageBlock::parseUpdate().

string* xmlFormatting ( const string & type,

const string & to,

const string & from,

const string & method,

const string & nonce,

const string & dependsOn,

double mtime,

const deque< Message::Field > & fields,

bool withLength

)

Converts a message into an XML format message.

Referenced by VOS::Message::Message().

Generated on Tue Aug 12 03:56:02 2003 for Interreality Project - VOS by 1.3.2