[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

VOS Namespace Reference

---

Detailed Description

Virtual Object System core library.

Classes

• class FileSystemError
• class FileSystemPersistance
• class HTTPServer
• class HTTPRequest
• struct LogEntry
• class ChangeLog
• class RevisionControlError
• class RevisionControlPersistance
• class RevControlAccess
• class ReadOnlyRevControlAccess
• class AcceptAllRevControlAccess
• class DenyAllRevControlAccess
• struct Conflict
• struct Status
• class VersionedVobject
• class MySQLResult
• class MySQLDatabase
• class SQLError
• struct SQLCell
• class SQLResult
• class SQLDatabase
• class SQLWriteThread
• class SQLPersistance
• class IrcBridge
• class IrcUser
• class IrcClient
• class Avatar

  Indicates that this object represents a human or automated agent. More...
  

• class Factory

  Factory ///. More...
  

• class LocalFactory
• class RemoteFactory
• class CODFactory

  CODFactory ///. More...
  

• class LocalCODFactory
• class RemoteCODFactory
• class CompoundFactory

  CompoundFactory ///. More...
  

• class LocalCompoundFactory
• class RemoteCompoundFactory
• class FactoryAccessControl
• class AcceptAllFactoryAccess
• class DenyAllFactoryAccess
• class Hypercard

  An object bearing this type suggests to the application that it may load the child object named "link" as a new document or enterable space for the user. More...
  

• class LogLevelCtrl
• class LocalLogLevelCtrl
• class RemoteLogLevelCtrl
• class LogLevelCtrlAccessControl
• class DenyAllLogLevelCtrlAC
• class ReadOnlyLogLevelCtrlAC
• class AcceptAllLogLevelCtrlAC
• class Metadata

  A MetaObject which holds metadata for the rest of the object, such as author, creation and modification time, copyright, etc. More...
  

• struct ParseNode
• struct search_parse_state_t
• class LocalSearch
• class RemoteSearch
• class searchFlexLexer
• class Talkative

  This object type facilitates verbal intercommunication in the form of text (which may be synthesized as human speech if possible). More...
  

• class TalkListener

  MetaObject implementing Talkative Object Type.Interface for message listeners. More...
  

• class TalkMessage

  Structure defining a talk message. More...
  

• class LocalTalkative

  Local implementation of Talkative. More...
  

• class RemoteTalkative

  Remote proxy for Talkative. More...
  

• class TalkativeAccessControl
• class AcceptAllTalkativeAC
• class SendOnlyTalkativeAC
• class DenyAllTalkativeAC
• class Services

  This metaobject provides a list of services it finds on the local network via Multicast DNS Service Discovery ("Rendezvous") or from remote Services objects. More...
  

• class VobjectAccessControl

  This is the base class for Vobject access control policies. More...
  

• class AcceptAllAccessControl

  Access control policy that always says yes. More...
  

• class ReadOnlyAccessControl

  Access control policy that allows requests for information (reads) but denies all changes. More...
  

• class DenyAllAccessControl

  Access control policy that always says no. More...
  

• class SiteAccessControl

  Access control checks specific to operations on Site objects. More...
  

• class AcceptAllSiteAccessControl

  Access control that always says yes. More...
  

• class DenyAllSiteAccessControl

  Access control that always says no. More...
  

• class AccessControlState

  This class stores and manages the access control lists for a particular local Vobject. More...
  

• class AccessControlList

  Class for managing an Access Control List (ACL). More...
  

• class ACLIterator
• class BasicLocalProperty

  Base class for local properties. More...
  

• class EndOfFileError
• class COD

  COD stands for Compact Object Description. More...
  

• class RemoteCOD

  The contents of a remote COD represent live objects on a remote site, rather than a save state which is to be loaded locally. More...
  

• class Identity

  Identity is the basic unit for determining access control. More...
  

• class Group

  A Group of Identity objects. More...
  

• class IdentityChangeListener

  Abstract interface for accepting identity change events. More...
  

• class IdentityChanged

  This class stores information used by the notifyEventChanged listener event. More...
  

• class PCRIterator

  Iterator subclass for iterating over pointers to the ParentChildRelation class. More...
  

• class StringIterator

  Iterator subclass for iterating over a list of std::string objects. More...
  

• class ChildChangeListener

  Interface to be called when a listened-to object has some change to its child list. More...
  

• class ParentChangeListener

  Interface to be called when a listened-to object has some change to its parent set. More...
  

• class TypeChangeListener

  Interface to be called when a listened-to object has some change to its type set. More...
  

• class DoNothingListener

  Trivial listener implementation that does nothing. More...
  

• class LocalProperty
• class LocalSite

  Extension of LocalVobject implementing server-side functionality to Site-specific functions: responding to requests to create and rename vobjects on the site and allowing a remote site to inquire as to what its current Identity is on this site. More...
  

• class LocalSiteExtension
• class RSSEIterator

  Iterator subclass used to iterate over pointers to RemoteSocketSiteExtension objects. More...
  

• class LocalSocketSiteExtension

  This class sets up the actual socket that the VOS site will listen on and manages a list of the remote sites we are connected to. More...
  

• class ListenerThread

  Internal thread started by LocalSocketSiteExtension. More...
  

• class SocketSitePeeringThread
• class RVSEIterator

  Iterator subclass used to iterate over pointers to RemoteVipSiteExtension objects. More...
  

• class LocalVipSiteExtension

  This class sets up the actual vip that the VOS site will listen on and manages a list of the remote sites we are connected to. More...
  

• class VipSitePeeringThread
• class LocalVobject

  Implements handlers that service the standard set of core messages for interacting with this Vobject. More...
  

• class NoSuchFieldError

  Thrown when getField() is passed an out-of-range parameter. More...
  

• struct SendingCompletedCallback
• class MsgField

  A key-value field pair used to store the fields of a Message. More...
  

• class Message

  This class handles storing, generating and parsing of the messages that are sent between virtual objects. 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 MBParser
• class BinaryParser
• class XmlParser
• class MessageBlock

  A message block is a list of messages which have been bundled together into a single block. More...
  

• class MetaObject

  This class forwards every method in the Vobject API to the VobjectBase that it is attached to. More...
  

• class ParentChildRelation

  This class represents the link from a parent to a child, describing the entry in the parent's child list. More...
  

• class LocalPasswordAuth

  This class should be a cotype with an Identity Vobject. More...
  

• class RemotePasswordAuth
• class Persistance

  An abstract interface for saving and loading blocks of data keyed by Vobject and a key string. More...
  

• class PersistBlockListener

  This is a listener interface used for notifications that a block in the persistance layer has been changed. More...
  

• class PolicyList

  The static members of this class manage the global list of registered access control policies for every access control domain. More...
  

• class PolicyDomain

  This class maps a string naming an access control policy onto an actual C++ implementation of the policy, within a particular policy domain. More...
  

• class ProcessMessage

  Task that processes a newly-received message block. More...
  

• class Property

  Property stores data of any type and size. More...
  

• class PropertyAccessControl

  Use subclasses of PropertyAccessControl to implement various access control policies on property reads and writes. More...
  

• class AcceptAllPropertyAccessControl
• class ReadOnlyPropertyAccessControl

  Access control policy for properties permits unlimited reads but denies allwrites and replaces. More...
  

• class DenyAllPropertyAccessControl

  Access control policy for properties permits unlimited reads but denies allwrites and replaces. More...
  

• class PropertyListener

  PropertyListener objects will be notified of all changes to Properties to which they are listening. More...
  

• class PropertyEvent

  PropertyEvents are passed to PropertyListener objectss to notify them of changes to the properties they are listening to. More...
  

• class DoNothingPropertyListener

  This is a PropertyListener that does nothing; however, it can be used to keep a RemoteProperty up to date with changes in a LocalProperty, speeding up reads of the RemoteProperty. More...
  

• class RemotePropertyListener
• class RemoteListener

  An internal class used to augment a remote site to accept notify event and dispatch the update messages peers over the network. More...
  

• class RemoteProperty
• class RemoteSiteExtension

  Used to extend a remote site so that createVobject(), setPeerIdentity() and renameVobject() send network requests to the actual site. More...
  

• class RemoteSocketSiteExtension

  Extends a remote site to support communication over a TCP/IP socket. More...
  

• class RemoteVipSiteExtension

  Extends a remote site to support communication over VIP. More...
  

• class RemoteVobject

  This class is hooks in via the VobjectBase extension mechanism and implements sending requests over the network to the actual site. More...
  

• class MessageFilter

  A message filter can be attached to any site to filter the messages passing through that site. More...
  

• class ProtocolHandler

  Abstract interface that implements connecting to a remote site with some particular protocol. More...
  

• class NoSuchMessageBlockError

  Thrown when a lookup for a stored message block fails. More...
  

• class NameAlreadyUsedError

  Thrown when an attempt to rename a Vobject fails due to there already being a Vobject with the new name. More...
  

• class ProtocolError

  Thrown when a critical protocol error has occurred. More...
  

• class ProgressMeterCallback

  Generic callback interface used to notify that progress has been made on some lengthy operation. More...
  

• class Site

  A site is the root of any collection of Vobjects. More...
  

• struct WaitingThread
• class SiteIterator
• class SiteExtension

  Allows you to hook into various methods on a Site object to extend their functionality. More...
  

• class PortBindingError
• class SitePeeringThread

  This may be used one of two ways. More...
  

• class NoSuchSiteError

  An exception class thrown when a remote site cannot be contacted. More...
  

• class NoSuchObjectError

  An exception class thrown when an object lookup fails. More...
  

• class AccessControlError
• class RemoteError

  An exception class thrown when a remote action fails. More...
  

• class TimeoutError

  An exception class thrown when an expected reply didn't arrive in the alloted time. More...
  

• class Dispatchable

  Used by metaobject and vobject extension classes to all them to accept message dispatch (directing messages with a given method string to a specific method). More...
  

• class Vobject

  This is the abstract class that defines the basic API common to all virtual objects. More...
  

• class MessageDispatch
• class MessageDispatchTemplate
• class VobjectBase

  A base implementation class for virtual objects. More...
  

• class VobjectEvent

  This class describes an event changing the state of a Vobject. More...
  

• class VobjectExtension

  Virtual Object System extension interface. More...
  

• class VobjectIterator
• class MetaObjectIterator
• class VobjectState

  This holds the actual state common to every Vobject: the type set, the child list, and the parent set. More...
  

• class VobjectStore
• class VobjectInput
• class VobjectOutput
• class VobjectStoreLoader
• class VobjectStoreSaver
• class UnsupportedFiletypeError
• class FileAccessError
• class VobjectImportExport
• struct ArgInfo
• class VOSApp
• class VOSPlugin
• class VOSPluginSharedObject
• class XOD

  XML Object Description. More...
  

Typedefs

• typedef std::vector< SQLCell > SQLRow
• typedef PCRIterator ChildListIterator
• typedef PCRIterator ParentSetIterator
• typedef StringIterator TypeSetIterator
• typedef PCRIterator ChildListIterator
• typedef PCRIterator ParentSetIterator
• typedef StringIterator TypeSetIterator
• typedef PCRIterator ChildListIterator
• typedef PCRIterator ParentSetIterator
• typedef StringIterator TypeSetIterator
• typedef PCRIterator ChildListIterator
• typedef PCRIterator ParentSetIterator
• typedef StringIterator TypeSetIterator
• typedef std::map< std::string,
  void * > ImpExpEnv

Functions

• MISC_API ParseNode * doSearchParse (const std::string &startrule)
• MISC_API void printParseTree (ParseNode *pn, int depth=0)
• int searchparse (void *lexer)

  Bison driver for searchparser.
  

• int searchlex (ParseNode **lvalp, void *lexer)

  Bison callback for serach parser.
  

• void searcherror (char *blah)

  Bison callback for XML parser.
  

• std::string * xmlFormatting (const std::string &type, const std::string &to, const std::string &from, const std::string &method, uint32_t nonce, const std::string &timestamp, const std::deque< VUtil::vRef< MsgField > > &fields, bool withLength)

  Converts a message into an XML format message.
  

• std::string * binaryFormatting (const std::string &type, const std::string &to, const std::string &from, const std::string &method, uint32_t nonce, const std::string &timestamp, const std::deque< VUtil::vRef< MsgField > > &fields, bool withLength)
• template<class C> VUtil::vRef< C > meta_cast (Vobject *v)

  A special cast which allows you to retrieve some interface (if available) on the supplied Vobject.

          vRef<Vobject> vobj = site.createVobject2<Property, World>();
          vRef<Property> property = meta_cast<Property>(vobj);
          vRef<World> w = meta_cast<World>(property);
  

  Parameters:

  v

  the object to be cast

  Returns:

  a vRef pointing to the new interface, or a null vRef if the vObject does not support this interface.

  
  

• template<class C> VUtil::vRef< C > meta_cast (Vobject &v)

  A special cast which allows you to retrieve some interface (if available) on the supplied Vobject.

          vRef<Vobject> vobj = site.createVobject2<Property, World>();
          vRef<Property> property = meta_cast<Property>(vobj);
          vRef<World> w = meta_cast<World>(property);
  

  Parameters:

  v

  the object to be cast

  Returns:

  a vRef pointing to the new interface, or a null vRef if the vObject does not support this interface.

  
  

• template<class C, class T> VUtil::vRef< C > meta_cast (VUtil::vRef< T > v)

  A special cast which allows you to retrieve some interface (if available) on the supplied Vobject.
  

• VOS_API PolicyDomain< VobjectAccessControl > & VobjectAccessControlPolicies ()
• VOS_API PolicyDomain< SiteAccessControl > & SiteAccessControlPolicies ()
• VOS_API void copyAccessControlPolicies (Vobject *to, Vobject *from)

  Copies the access control policies (default policy + access control lists) from one Vobject to another.
  

• VOS_API bool sameAccessControlLists (Vobject *a, Vobject *b)

Variables

• VOS_API PolicyDomain< PropertyAccessControl > PropertyAccessControlPolicies

---

Typedef Documentation

typedef std::vector<SQLCell> VOS::SQLRow

Definition at line 23 of file sqldb.hh.

typedef PCRIterator VOS::ChildListIterator

Definition at line 39 of file iterator.hh.

typedef PCRIterator VOS::ParentSetIterator

Definition at line 41 of file iterator.hh.

typedef StringIterator VOS::TypeSetIterator

Definition at line 42 of file iterator.hh.

typedef PCRIterator VOS::ChildListIterator

Definition at line 53 of file vobject.hh.

typedef PCRIterator VOS::ParentSetIterator

Definition at line 55 of file vobject.hh.

typedef StringIterator VOS::TypeSetIterator

Definition at line 56 of file vobject.hh.

typedef PCRIterator VOS::ChildListIterator

Definition at line 57 of file vobjectextension.hh.

typedef PCRIterator VOS::ParentSetIterator

Definition at line 59 of file vobjectextension.hh.

typedef StringIterator VOS::TypeSetIterator

Definition at line 60 of file vobjectextension.hh.

typedef PCRIterator VOS::ChildListIterator

Definition at line 54 of file vobjectstate.hh.

typedef PCRIterator VOS::ParentSetIterator

Definition at line 56 of file vobjectstate.hh.

typedef StringIterator VOS::TypeSetIterator

Definition at line 57 of file vobjectstate.hh.

typedef std::map<std::string, void*> VOS::ImpExpEnv

Definition at line 163 of file vobjectstore.hh.

---

Function Documentation

MISC_API ParseNode* VOS::doSearchParse

(

const std::string &

startrule

)

MISC_API void VOS::printParseTree	(	ParseNode *	pn,
		int	depth = 0
	)

int VOS::searchparse

(

void *

lexer

)

Bison driver for searchparser.

For internal use only.

int VOS::searchlex	(	ParseNode **	lvalp,
		void *	lexer
	)

Bison callback for serach parser.

For internal use only.

void VOS::searcherror

(

char *

blah

)

Bison callback for XML parser.

For internal use only.

std::string* VOS::xmlFormatting	(	const std::string &	type,
		const std::string &	to,
		const std::string &	from,
		const std::string &	method,
		uint32_t	nonce,
		const std::string &	timestamp,
		const std::deque< VUtil::vRef< MsgField > > &	fields,
		bool	withLength
	)

Converts a message into an XML format message.

std::string* VOS::binaryFormatting	(	const std::string &	type,
		const std::string &	to,
		const std::string &	from,
		const std::string &	method,
		uint32_t	nonce,
		const std::string &	timestamp,
		const std::deque< VUtil::vRef< MsgField > > &	fields,
		bool	withLength
	)

VOS_API PolicyDomain<VobjectAccessControl>& VOS::VobjectAccessControlPolicies

(

)

VOS_API PolicyDomain<SiteAccessControl>& VOS::SiteAccessControlPolicies

(

)

VOS_API void VOS::copyAccessControlPolicies	(	Vobject *	to,
		Vobject *	from
	)

Copies the access control policies (default policy + access control lists) from one Vobject to another.

VOS_API bool VOS::sameAccessControlLists	(	Vobject *	a,
		Vobject *	b
	)

Returns:

true if the the supplied have the same access control lists (comparison does NOT include default policies).

---

Variable Documentation

VOS_API PolicyDomain<PropertyAccessControl> VOS::PropertyAccessControlPolicies