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

libvos

---

Detailed Description

VOS Library.

required libraries: @ @ @ @

Classes

• class VOS::VobjectAccessControl

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

• class VOS::AcceptAllAccessControl

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

• class VOS::ReadOnlyAccessControl

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

• class VOS::DenyAllAccessControl

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

• class VOS::SiteAccessControl

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

• class VOS::AcceptAllSiteAccessControl

  Access control that always says yes. More...
  

• class VOS::DenyAllSiteAccessControl

  Access control that always says no. More...
  

• class VOS::AccessControlState

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

• class VOS::AccessControlList

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

• class VOS::ACLIterator
• class VOS::EndOfFileError
• class VOS::COD

  COD stands for Compact Object Description. More...
  

• class VOS::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 VOS::Identity

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

• class VOS::Group

  A Group of Identity objects. More...
  

• class VOS::IdentityChangeListener

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

• class VOS::IdentityChanged

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

• class VOS::PCRIterator

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

• class VOS::StringIterator

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

• class VOS::ChildChangeListener

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

• class VOS::ParentChangeListener

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

• class VOS::TypeChangeListener

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

• class VOS::DoNothingListener

  Trivial listener implementation that does nothing. More...
  

• class VOS::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 VOS::RSSEIterator

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

• class VOS::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 VOS::ListenerThread

  Internal thread started by LocalSocketSiteExtension. More...
  

• class VOS::RVSEIterator

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

• class VOS::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 VOS::LocalVobject

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

• class VOS::NoSuchFieldError

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

• class VOS::MsgField

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

• class VOS::Message

  This class handles storing, generating and parsing of the messages that are sent between virtual objects. More...
  

• class VOS::MessageBlock

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

• class VOS::MetaObject

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

• class VOS::ParentChildRelation

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

• class VOS::LocalPasswordAuth

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

• class VOS::RemotePasswordAuth
• class VOS::Persistance

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

• class VOS::PersistBlockListener

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

• class VOS::PolicyList

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

• class VOS::PolicyDomain< ACType >

  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 VOS::ProcessMessage

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

• class VOS::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 VOS::RemoteSiteExtension

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

• class VOS::RemoteSocketSiteExtension

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

• class VOS::RemoteVipSiteExtension

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

• class VOS::RemoteVobject

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

• class VOS::MessageFilter

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

• class VOS::ProtocolHandler

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

• class VOS::NoSuchMessageBlockError

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

• class VOS::NameAlreadyUsedError

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

• class VOS::ProtocolError

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

• class VOS::ProgressMeterCallback

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

• class VOS::Site

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

• class VOS::SiteIterator
• class VOS::SiteExtension

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

• class VOS::PortBindingError
• class VOS::SitePeeringThread

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

• class VOS::NoSuchSiteError

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

• class VOS::NoSuchObjectError

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

• class VOS::AccessControlError
• class VOS::RemoteError

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

• class VOS::TimeoutError

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

• class VOS::Vobject

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

• class VOS::MessageDispatch
• class VOS::VobjectBase

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

• class VOS::VobjectEvent

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

• class VOS::VobjectExtension

  Virtual Object System extension interface. More...
  

• class VOS::VobjectIterator
• class VOS::MetaObjectIterator
• class VOS::VobjectState

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

• class VUtil::URL

  A class implementing basic handling of Uniform Resource Locator (URL) expressions. More...
  

Functions

• template<> void VUtil::iteratorReleaseItem (VOS::ParentChildRelation **pcr)

  Specialization to call release on ParentChildRelation objects.
  

• template<class C> VUtil::vRef< C > VOS::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 > VOS::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 > VOS::meta_cast (VUtil::vRef< T > v)

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

---

Function Documentation

template<>

void VUtil::iteratorReleaseItem

(

VOS::ParentChildRelation **

pcr

)

[inline]

Specialization to call release on ParentChildRelation objects.

Definition at line 55 of file iterator.hh.

template<class C, class T>

VUtil::vRef<C> VOS::meta_cast

(

VUtil::vRef< T >

v

)

[inline]

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.

Definition at line 40 of file meta_cast.hh.

template<class C>

VUtil::vRef<C> VOS::meta_cast

(

Vobject &

v

)

[inline]

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.

Definition at line 21 of file meta_cast.hh.

template<class C>

VUtil::vRef<C> VOS::meta_cast

(

Vobject *

v

)

[inline]

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.

Definition at line 12 of file meta_cast.hh.