vos/corelibs/vos/remotestreamsite.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 _REMOTESTREAMSITE_HH_
#define _REMOTESTREAMSITE_HH_

/** @file
    Defines RemoteStreamSite.
*/

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

namespace VOS
{
    class MessageBlock;
    class message;

/** @class RemoteStreamSite remotestreamsite.hh vos/corelibs/vos/remotestreamsite.hh
 * A simulated remote site using a file for input instead of a
    network socket.
 */
class VOS_API RemoteStreamSite : public virtual RemoteSite
{
protected:
    FILE* readingFILE;
    FILE* writingFILE;
    bool pretendIsLocal;
    bool isScript;

    MessageBlock* partialMessage;

    virtual int readStream(char* data, unsigned int datasize);
    virtual int writeStream(const char* data, unsigned int datasize);
public:
    RemoteStreamSite(FILE* readfd, FILE* writefd);
    virtual ~RemoteStreamSite();

    /** @throw SiteConnectionError */
    virtual void sendMessage(Message* m);
    virtual void sendMessage(MessageBlock* mb);
    virtual void handleDisconnection();
    virtual void flushIncomingBuffers();
    virtual void flushOutgoingBuffers(const char* data = 0, unsigned int sz = 0) {};

    virtual bool isLocal() { return pretendIsLocal; }
    virtual bool isRemote() { return !pretendIsLocal; }

    virtual bool isConnected();

    /** Runs a script file (a session of VOS messages.)  The reason
        why this is in RemoteStreamSite is because it works by
        creating a temporary "fake" site from which the messages will
        originate.

        @param filename The script file to load.  If the filename ends
        in ".gz", it will be automatically decompressed with gzip!
        @param ls the local site which will receive the script messages
        @param lastmessage an optional final message that will be sent to the local site
        right before the script is completed.
        @note If you are opening a gzipped file, "gunzip" is called
        using popen() which calls the shell.  This means that
        untrusted filenames should not be passed into this function!
        @return true if the script loaded successfully, false if there
        was an error.  Does @em not report syntax errors in the script, however.
     */
    static bool runScript(const string& filename, LocalSite& ls, Message* lastmessage=0);
};
}

#endif

---