vos/corelibs/vos/remotemetaobject.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 _REMOTEMETAOBJECT_HH_
#define _REMOTEMETAOBJECT_HH_

/** @file
    Defines RemoteMetaObject.
*/

#include <vos/corelibs/vos/vosdefs.hh>
#include <vos/corelibs/vos/metaobject.hh>
#include <vos/corelibs/vos/remotevobject.hh>

namespace VOS
{
/** @class RemoteMetaObject remotemetaobject.hh vos/corelibs/vos/remotemetaobject.hh

    A RemoteMetaObject is a Remote Vobject supporting the MetaObject
    extension architechture, allowing you to use meta_cast to select
    between available C++ interfaces supported by the Vobject type.
 */
class VOS_API RemoteMetaObject : public virtual MetaObject, public virtual RemoteVobject
{
protected:
    RemoteMetaObject(const string& name, RemoteSite* remotesite);
public:
    virtual ~RemoteMetaObject();

    virtual const string& getName();
    virtual Site& getSite();
    virtual const URL& getURL();
    virtual bool isLocal();
    virtual bool isRemote();
    virtual const TypeSet& getTypes()
        throw (AccessControlError, RemoteError);
    virtual void addType(const string& s);
    virtual const ParentSet& getParents()
        throw (AccessControlError, RemoteError);
    virtual const ChildList& getChildren()
        throw (AccessControlError, RemoteError);

    virtual void sendMessage(Message* m);
    virtual void sendMessage(MessageBlock* m);
    virtual Message* receiveMessage() throw (MessageQueueEmptyError);
    virtual bool hasMessageAvailable();

    virtual void handleNewType(const string& t);

    virtual void sendUpdateMessage(Message* m);
    virtual Message* receiveUpdateMessage() throw (MessageQueueEmptyError);
    virtual bool hasUpdateMessageAvailable();

    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 Vobject::ParentChildRelation& findParent(Vobject& parent)
        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 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 saveState(MessageBlock& output, set<string>& types, bool portable);

    virtual void addFlag(const string& flag);
    virtual void removeFlag(const string& flag);
    virtual bool checkFlag(const string& flag);

    virtual void excise();
    virtual void acquire();
    virtual void release();
    virtual int getCount();

    friend class RemoteSite;
};
}

#endif

---