vos/corelibs/vos/remotesite.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-2003 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 _REMOTESITE_HH_
#define _REMOTESITE_HH_

/** @file
    Defines RemoteSite.
*/

#include <vos/corelibs/vos/vosdefs.hh>
#include <vos/corelibs/vos/site.hh>
#include <vos/corelibs/vos/remotemetaobject.hh>
#include <vos/corelibs/vos/listener.hh>
#include <vos/corelibs/vos/localsite.hh>

#include <map>

namespace VOS
{
/** @class RemoteSite remotesite.hh vos/corelibs/vos/remotesite.hh
 *
 *  This class manages a connection to a remote site and the
 *  objects bound to that site.
 */
class VOS_API RemoteSite : public virtual Site, public virtual RemoteMetaObject,
                       public virtual VOS::ChildChangeListener,
                       public virtual VOS::ParentChangeListener,
                       public virtual VOS::TypeChangeListener
{
private:
    typedef multimap<string, metaobject_extender_t>::iterator MI;
    static multimap<string, metaobject_extender_t> remoteObjectExtensionTable;
    string antispoofid;
public:
    class SiteConnectionError : public RemoteError {
    public:
        SiteConnectionError(const string& s) : RemoteError(s) { }
    };
    class NoLocalPeerError : public RemoteError {
    public:
        NoLocalPeerError(const string& s) : RemoteError(s) { }
    };
protected:
    LocalSite* localpeer;
    bool disconnected;
    set<Vobject*> childlockSet;
    set<Vobject*> parentlockSet;
    set<Vobject*> typelockSet;
    map<string, pair<bool, Message*> > waitingFor;

    RemoteSite();
public:
    virtual ~RemoteSite();

    /** Get the local site this remote site is peered with.
        @throws NoLocalPeerError if there is no local peer
        (which probably means the application has not created a local site yet!)
        @return the local site to which this remote site is peered.
        NOTE YOU MUST CALL release() WHEN DONE OR USE A rREF() BLOCK */
    virtual LocalSite& getLocalPeer() throw (NoLocalPeerError);

    virtual void flushIncomingBuffers() = 0;
    virtual void flushOutgoingBuffers(const char* data = 0, unsigned int sz = 0) = 0;

    void setChild(int position, const string& contextual_name, Vobject* child)
        throw (AccessControlError, TimeoutError);
    virtual void setURL(const URL& u);
    virtual Site& getSite() { return Site::getSite(); }

    virtual void excise();
    virtual void release();

    virtual void sendMessage(Message* m) = 0;
    virtual void sendMessage(MessageBlock* m) = 0;
    virtual void sendUpdateMessage(Message* m);

    virtual void lockChildNotifyOutgoing(Vobject* v);
    virtual void unlockChildNotifyOutgoing(Vobject* v, const string& nonce);
    virtual void lockParentNotifyOutgoing(Vobject* v);
    virtual void unlockParentNotifyOutgoing(Vobject* v, const string& nonce);
    virtual void lockTypeNotifyOutgoing(Vobject* v);
    virtual void unlockTypeNotifyOutgoing(Vobject* v, const string& nonce);

    virtual void notifyChildInserted(VobjectEvent& e);
    virtual void notifyChildReplaced(VobjectEvent& e);
    virtual void notifyChildRemoved(VobjectEvent& e);
    virtual void notifyParentInserted(VobjectEvent& e);
    virtual void notifyParentRemoved(VobjectEvent& e);
    virtual void notifyTypeInserted(VobjectEvent& e);
    virtual void notifyTypeRemoved(VobjectEvent& e);

    static void extendMetaObject(RemoteMetaObject* root, const char* type);
//    static void extendMetaObjectV(RemoteMetaObject* root, va_list ap);


    virtual MetaObject* createMetaObject(const char* name, const char* first, ...);
    virtual MetaObject* createMetaObject(const char* name, const deque<string>& typelist);

#if 0
    virtual MetaObject* createMetaObject();
    virtual MetaObject* createMetaObjectT(const char* first, ...);
    virtual MetaObject* createMetaObjectV(va_list ap);
    virtual MetaObject* createMetaObject(const deque<string>& typelist);

    virtual MetaObject* createMetaObjectV(const string& name, va_list ap);
#endif

    static void addRemoteObjectExtension(const char* type, metaobject_extender_t newmethod);
    static void removeRemoteObjectExtension(const char* type, metaobject_extender_t oldmethod);
    static void printExtensionTable(ostream& stream = std::cerr);

    virtual void addNotification(NotifyEvent* ev);
    virtual void flushNotifications();
    virtual void lockNotificationFlush();
    virtual void unlockNotificationFlush();

    /** Save an incoming message -- used by LocalVobject::waitFor */
    virtual void catchIncomingMessage(const string& nonce);

    /** Stop watching for that nonce */
    virtual void clearCaughtMessage(const string& nonce);

    /** Is a waited-for message still being downloaded? */
    virtual bool messageInProgress(const string& nonce);

    /** Is a waited-for message ready to be retrieved? */
    virtual bool messageReady(const string& nonce);

    /** Get a waited-for message nonce.  You need to call
        clearCaughtMessage() to stop waiting for that nonce.
        @return the message (or possible 0!), note that you should use vRef to release it!
    */
    virtual Message* retrieveCaughtMessage(const string& nonce);

    /** The anti-spoof ID we sent to this site. */
    void setAntiSpoofID(const string& s) { antispoofid = s; }

    /** The anti-spoof ID we sent to this site. */
    const string& getAntiSpoofID() { return antispoofid; }

    virtual bool isConnected() = 0;

    friend void Site::doSitePeering(LocalSite* localsite, RemoteSite* remotesite, bool isspooftest, bool waitforhello);
};
}

#endif

---