![interreality.org [VOS]](/wwwvos/banner5.jpg)
VOS::SiteExtension Class Reference
[libvos]
#include <vos/vos/siteextension.hh>
Inheritance diagram for VOS::SiteExtension:
Detailed Description
Allows you to hook into various methods on a Site object to extend their functionality.You want to subclass this and override the methods you are interested in. The pre_ methods are called prior to running the default behavior of the method. The post_ methods are run after the default behavior of the method has executed. If you return "false" from a pre_ method this will prevent the default behavior from being run, meaning it will return after running all the pre_ extensions; this also means it will also skip running any post_ methods.
You can also override doSendMessage(), generally this is done to implement the actual physical sending the serialized version of a message to a remote site.
Definition at line 25 of file siteextension.hh.
Public Member Functions
- virtual ~SiteExtension ()
- virtual void siteExtensionAttachedTo (Site *st)
- virtual VUtil::vRef< VobjectBase > pre_createVobject (VobjectState &state, Vobject *requester, const char *name, const std::deque< std::string > &typelist)
- virtual void post_createVobject (VobjectState &state, Vobject *requester, VobjectBase *newvobject)
- virtual bool pre_renameVobject (VobjectState &state, Vobject *requester, const std::string &oldname, const std::string &newname)
- virtual void post_renameVobject (VobjectState &state, Vobject *requester, const std::string &oldname, const std::string &newname)
- virtual void pre_getMyIdentity (VUtil::vRef< Identity > &myIdentity)
- virtual void post_setPeerIdentity (VUtil::vRef< Identity > peerIdentity)
- virtual void doSendMessage (VobjectState &state, Message *m)
- virtual void doSendMessage (VobjectState &state, MessageBlock *m)
Constructor & Destructor Documentation
| virtual VOS::SiteExtension::~SiteExtension | ( | ) | [inline, virtual] |
Definition at line 28 of file siteextension.hh.
Member Function Documentation
| virtual void VOS::SiteExtension::doSendMessage | ( | VobjectState & | state, | |
| MessageBlock * | m | |||
| ) | [inline, virtual] |
Reimplemented in VOS::RemoteSocketSiteExtension, and VOS::RemoteVipSiteExtension.
Definition at line 48 of file siteextension.hh.
| virtual void VOS::SiteExtension::doSendMessage | ( | VobjectState & | state, | |
| Message * | m | |||
| ) | [inline, virtual] |
Reimplemented in VOS::RemoteSocketSiteExtension, and VOS::RemoteVipSiteExtension.
Definition at line 47 of file siteextension.hh.
| virtual void VOS::SiteExtension::post_createVobject | ( | VobjectState & | state, | |
| Vobject * | requester, | |||
| VobjectBase * | newvobject | |||
| ) | [inline, virtual] |
Reimplemented in VOS::FileSystemPersistance, VOS::RevisionControlPersistance, VOS::VersionedVobject, and VOS::SQLPersistance.
Definition at line 37 of file siteextension.hh.
| virtual void VOS::SiteExtension::post_renameVobject | ( | VobjectState & | state, | |
| Vobject * | requester, | |||
| const std::string & | oldname, | |||
| const std::string & | newname | |||
| ) | [inline, virtual] |
Reimplemented in VOS::FileSystemPersistance, VOS::RevisionControlPersistance, VOS::VersionedVobject, and VOS::SQLPersistance.
Definition at line 41 of file siteextension.hh.
| virtual void VOS::SiteExtension::post_setPeerIdentity | ( | VUtil::vRef< Identity > | peerIdentity | ) | [inline, virtual] |
| virtual VUtil::vRef<VobjectBase> VOS::SiteExtension::pre_createVobject | ( | VobjectState & | state, | |
| Vobject * | requester, | |||
| const char * | name, | |||
| const std::deque< std::string > & | typelist | |||
| ) | [inline, virtual] |
| virtual void VOS::SiteExtension::pre_getMyIdentity | ( | VUtil::vRef< Identity > & | myIdentity | ) | [inline, virtual] |
Definition at line 44 of file siteextension.hh.
| virtual bool VOS::SiteExtension::pre_renameVobject | ( | VobjectState & | state, | |
| Vobject * | requester, | |||
| const std::string & | oldname, | |||
| const std::string & | newname | |||
| ) | [inline, virtual] |
| virtual void VOS::SiteExtension::siteExtensionAttachedTo | ( | Site * | st | ) | [inline, virtual] |
Reimplemented in VOS::FileSystemPersistance, VOS::HTTPServer, VOS::RevisionControlPersistance, VOS::SQLPersistance, VOS::LocalSiteExtension, VOS::LocalSocketSiteExtension, VOS::LocalVipSiteExtension, VOS::RemoteSiteExtension, VOS::RemoteSocketSiteExtension, and VOS::RemoteVipSiteExtension.
Definition at line 30 of file siteextension.hh.
The documentation for this class was generated from the following file:
- /home/tetron/hack/vos/libs/vos/vos/siteextension.hh