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

/home/tetron/hack/vos/libs/vos/vos/siteextension.hh

Go to the documentation of this file.

#ifndef _SITEEXTENSION_HH_
#define _SITEEXTENSION_HH_

#include <vos/vos/vobjectbase.hh>
#include <vos/vos/identity.hh>

namespace VOS {
    /** @class SiteExtension siteextension.hh vos/vos/siteextension.hh
        @ingroup libvos

        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.
    */
    class VOS_API SiteExtension : public Dispatchable
    {
    public:
        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)
            {
                return VUtil::vRef<VobjectBase>();
            };
        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) { return true; };
        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) { };
    };
}

#endif