vos/metaobjects/property/bufferedproperty.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>
    Additions by Reed Hedges <reed@zerohour.net> marked with initials "rh" and date.
*/
#ifndef _BUFFFEREDPROPERTY_HH_
#define _BUFFFEREDPROPERTY_HH_

#include <typeinfo>
#include <set>

class BufferedLocalProperty;

#include <vos/corelibs/vos/vos.hh>
#include "property.hh"

/** @class BufferedLocalProperty bufferedproperty.hh vos/metaobjects/property/bufferedproperty.hh
 *
 * This subclass of Property waits until you call flush() (or the static
 * method flushAll()) before actually sending any write or replace methods
 * to listeners.
 */
class PROPERTY_API BufferedLocalProperty : public virtual LocalProperty
{
protected:
    static set<BufferedLocalProperty*> allblps;
    bool changed;
    int changestart;
    int changelen;
public:
    BufferedLocalProperty(MetaObject* superobject);
    BufferedLocalProperty(MetaObject* superobject, const string& d, const string& dt = "?");
    virtual ~BufferedLocalProperty();
    static MetaObject* new_BufferedLocalProperty(MetaObject* superobject, const string& type);
    static void registerExtenders();

    /** Flush pending changes for all BufferedLocalProperty objects created
     *  in this process so far.
     */
    static void flushAll();

    virtual void write(int start, const string& newdata);
    virtual void replace(const string& newdata, const string& newtype = "?");

    /** Flush pending changes for this property. */
    virtual void flush();
};

/** @class BufferedRemoteProperty bufferedproperty.hh vos/metaobjects/property/bufferedproperty.hh
 */
class PROPERTY_API BufferedRemoteProperty : public virtual RemoteProperty
{
protected:
    static set<BufferedRemoteProperty*> allbrps;
    bool changed;
    int changestart;
    int changelen;
    bool lastmsgsuccess;
    string lastnonce;

public:
    BufferedRemoteProperty(MetaObject* superobject);
    ~BufferedRemoteProperty();
    static MetaObject* new_BufferedRemoteProperty(MetaObject* superobject, const string& type);
    static void registerExtenders();
    static void flushAll();

    virtual void write(int start, const string& newdata);
    virtual void replace(const string& newdata, const string& newtype = "?");
    virtual void flush();
    virtual void sendUpdateMessage(Message* m);
};

#endif

---