VRS - The Virtual Rendering System

version 3.3

twopointconnection.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * 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.1 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 FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: twopointconnection.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.8  2004/11/09 15:07:01  kirsch
// further changes to class comments due to doxygen
//
// Revision 1.7  2004/06/15 08:54:57  buchholz
// stream operator for strings replaced by methods
// sendString/receiveString to handle unknown string lengths
//
// Revision 1.6  2004/03/12 16:28:41  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.5  2004/01/19 11:43:58  baumann
// serialization mechanism improved
//
// Revision 1.4  2004/01/19 07:28:04  baumann
// serialization mechanism improved
//
// Revision 1.3  2003/11/13 11:59:01  buchholz
// some gcc warnings fixed
//
// Revision 1.2  2003/11/12 13:01:26  buchholz
// start/stop methods added
//
// Revision 1.1  2003/11/12 11:42:21  buchholz
// first checkin of the vrs-qt-network classes
//

#ifndef VRS_QT_TWOPOINTCONNECTION_H
#define VRS_QT_TWOPOINTCONNECTION_H

#include <vrs/qt3/config.h>
#include <vrs/sharedobj.h>
#include <vrs/vector.h>
#include <deque>
#include <vector>

namespace VRS {

template<typename T> class NonPersistentArray;


class VRS_QT3_API TwoPointConnection : public SharedObj {
public:
    
    TwoPointConnection();

        void start(int port);

    
    void start(std::string host, int port);

    void stop();

        virtual ~TwoPointConnection();
                
    int bytesReceived() const;


    bool connected() const;

    void flush();

    void setFlushThreshold(unsigned int size = 0);
    unsigned int getFlushThreshold() const;

    TwoPointConnection& operator<<(VRS::UINT8);
    TwoPointConnection& operator<<(VRS::UINT16);
    TwoPointConnection& operator<<(VRS::UINT32);
    TwoPointConnection& operator<<(VRS::UINT64);
    TwoPointConnection& operator<<(float);
    TwoPointConnection& operator<<(double);
    TwoPointConnection& operator<<(bool);    
    TwoPointConnection& operator<<(Vector);
    TwoPointConnection& operator<<(SO<SharedObj>);

    TwoPointConnection& operator>>(VRS::UINT8&);
    TwoPointConnection& operator>>(VRS::UINT16&);
    TwoPointConnection& operator>>(VRS::UINT32&);
    TwoPointConnection& operator>>(VRS::UINT64&);
    TwoPointConnection& operator>>(float&);
    TwoPointConnection& operator>>(double&);
    TwoPointConnection& operator>>(bool&);    
    TwoPointConnection& operator>>(Vector&);
    TwoPointConnection& operator>>(SO<SharedObj>&);
    
    void restore(VRS::UINT8);
    void restore(VRS::UINT16);
    void restore(VRS::UINT32);
    void restore(VRS::UINT64);
    void restore(float);
    void restore(double);
    void restore(bool);
    void restore(std::string);
    void restore(Vector);
    void restore(SO<SharedObj>);
    void sendString(const std::string& s);
    bool receiveString(std::string& s);
    void registerReceiveCB(Callback1<SharedObj*>* cb);
    void unregisterReceiveCB(Callback1<SharedObj*>* cb);
    void registerDisconnectCB(Callback1<SharedObj*>* cb);
    void unregisterDisconnectCB(Callback1<SharedObj*>* cb);
    void registerConnectCB(Callback1<SharedObj*>* cb);
    void unregisterConnectCB(Callback1<SharedObj*>* cb);
    void registerErrorCB(Callback1<SharedObj*>* cb);
    void unregisterErrorCB(Callback1<SharedObj*>* cb);
    enum NetworkError { ERR_NO_ERROR, ERR_CONNECTION_REFUSED, ERR_HOST_NOT_FOUND, ERR_SOCKET_READ };
    VRS_SERIALIZABLE_CLASS_ENUM(NetworkError);
    // ERR_CONNECTION_REFUSED: The connection was refused.
    // ERR_HOST_NOT_FOUND:     A client has tried to connect to a host that could not be found
    // ERR_SOCKET_READ:        An error ocurred while sending data. */
    NetworkError getLastError() const;

    class ImplServer; 
    class ImplClient;
    
    VRS_TYPEINFO(TwoPointConnection, SharedObj);

private:
        
    friend class ImplClient;
    void onReceive();
    void onDisconnect();
    void onConnect();
    void onError(NetworkError error);
    
    ImplServer* server_;
    ImplClient* client_;
    unsigned int autoFlushAt_;

    std::deque<VRS::UINT8> inBuffer_;
    std::vector<VRS::UINT8> outBuffer_;
        
    enum CB_ID { CB_RECEIVE, CB_DISCONNECT, CB_CONNECT, CB_ERROR };
    VRS_SERIALIZABLE_CLASS_ENUM(CB_ID);
    void registerCallback(Callback1<SharedObj*>* cb, CB_ID id);
    void unregisterCallback(Callback1<SharedObj*>* cb, CB_ID id);
    void activateCallbacks(CB_ID id);
    SO<NonPersistentArray<std::pair<SO<Callback1<SharedObj*> >, CB_ID> > > callbacks_;    
    NetworkError lastError_;
};
  
} // namespace VRS

#endif // VRS_QT_TWOPOINTCONNECTION_H

---

Generated on Thu May 24 06:00:16 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact