vos/corelibs/vos/remotevobject.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001, 2002 Peter Amstutz

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <tetron@interreality.org>
*/
#ifndef _REMOTEVOBJECT_HH_
#define _REMOTEVOBJECT_HH_

/** @file
    Defines RemoteVobject.
*/

#include <vos/corelibs/vos/vosdefs.hh>
#include <vos/corelibs/vos/vobject.hh>

namespace VOS
{
    class Message;
    class RemoteSite;
    class LocalSite;

/** @class RemoteVobject remotevobject.hh vos/corelibs/vos/remotevobject.hh
 * This class allows you to access remotely Vobjects as if they were
    local.
 */
class VOS_API RemoteVobject : public virtual VobjectImplementation
{
private:
    void addChildUpdateHandler(Message* m);
    void addParentUpdateHandler(Message* m);
    void removeChildUpdateHandler(Message* m);
    void removeParentUpdateHandler(Message* m);
    void typeUpdateHandler(Message* m);
    void addListenerReplyHandler(Message* m);

    bool resetChildren;
protected:
    RemoteVobject(const string& name, RemoteSite* remotesite);
public:
    virtual ~RemoteVobject();

    virtual void sendMessage(Message* m);
    virtual void sendMessage(MessageBlock* m);
    virtual void sendUpdateMessage(Message* m);
    virtual const ChildList& getChildren()
        throw (AccessControlError, RemoteError);
    virtual const ParentSet& getParents()
        throw (AccessControlError, RemoteError);
    virtual const TypeSet& getTypes()
        throw (AccessControlError, RemoteError);

    virtual Vobject& findObject(const string& path)
        throw (NoSuchSiteError, NoSuchObjectError, URL::BadURLError, AccessControlError, RemoteError);

    virtual Vobject::ParentChildRelation& findChild(const string& path)
        throw (NoSuchObjectError, AccessControlError, RemoteError);
    virtual void setChild(int position, const string& contextual_name, Vobject* child)
        throw (AccessControlError, RemoteError);
    virtual void  insertChild(int position, const string& contextual_name, Vobject* child)
        throw (AccessControlError, RemoteError);
    virtual void removeChild(int position)
        throw (AccessControlError, RemoteError);
    virtual void addType(const string& type);

    virtual void addTypeListener(TypeChangeListener* tl, bool notifyImmediately = true);
    virtual void addParentListener(ParentChangeListener* pl, bool notifyImmediately = true);
    virtual void addChildListener(ChildChangeListener* cl, bool notifyImmediately = true);
    virtual void removeTypeListener(TypeChangeListener* tl);
    virtual void removeParentListener(ParentChangeListener* pl);
    virtual void removeChildListener(ChildChangeListener* cl);

    virtual void acquire();
    virtual void release();

    /** Convenience function which initializes various message fields when
        sending out a message.
        @param v the remote object emitting this message
        @param m the message to be filled in
        @param method the method field
        @param withnonce whether to generate a nonce or not
        @returns The local site which this remote object's site is
        peered to.  This is useful because you often want to do something like
        @code
    vRef<Message> m = new Message();
        vRef<LocalSite> ls = initFields(this, &m, "my-method", true);
        // fill in some other fields here
    sendMessage(&m);
    vRef<Site> site = getSite();
        vRef<Message> thereply = ls->waitFor(m->getNonce(), dynamic_cast<RemoteSite*>(&site));
        // do stuff with 'thereply'
        @endcode
        NOTE YOU MUST CALL release() WHEN DONE OR USE A rREF() BLOCK (as shown above)
        @note Here is what this method actually does:
        @code
        m->setType("message");
        LocalSite& ls = dynamic_cast<RemoteSite*>(&(v->getSite()))->getLocalPeer();
        m->setFrom(ls.getURL().getString());
        m->setTo(v->getURL().getString());
        m->setMethod(method);
        if(withnonce) m->generateNonce();
        @endcode
        See also LocalVobject::initReply()
    */
    static LocalSite& initFields(Vobject* v, Message* m, const string& method, bool withnonce);
};
}

#endif

---