netsocket.h

Go to the documentation of this file.

#ifndef netsocket_h
#define netsocket_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          August 2014
 RCS:           $Id$
________________________________________________________________________

-*/


#include "networkmod.h"
#include "callback.h"
#include "threadlock.h"
#include "uistring.h"

class BufferString;
template <class T> class DataInterpreter;
mFDQtclass(QTcpSocket)
mFDQtclass(QTcpSocketComm)


namespace Network
{

class RequestPacket;


mExpClass(Network) Socket : public CallBacker
{ mODTextTranslationClass(Socket);

public:
                Socket(bool haveeventloop=true);
                Socket(mQtclass(QTcpSocket)*,bool haveeventloop=true);
                ~Socket();

    void        setTimeout(int ms) { timeout_ = ms; }

    static const char*  sKeyLocalHost() { return "localhost"; }

    bool        connectToHost(const char* host,int port,
                              bool wait=true);
    bool        disconnectFromHost(bool wait=false);

    bool        isBad() const;
    bool        isConnected() const;
    od_int64    bytesAvailable() const;
    uiString    errMsg() const  { return errmsg_; }
    void        abort();        

    bool        writeChar(char);
    bool        writeShort(short);
    bool        writeInt32(od_int32);
    bool        writeInt64(od_int64);
    bool        writeFloat(float);
    bool        writeDouble(double);
    bool        write(const OD::String&);
    bool        write(const IOPar&);

    bool        write(const Network::RequestPacket&,bool wait=false);

    bool        writeArray(const void*,od_int64,bool wait=false);
    bool        writeShortArray(const short*,od_int64,bool wait=false);
    bool        writeInt32Array(const od_int32*,od_int64,bool wait=false);
    bool        writeInt64Array(const od_int64*,od_int64,bool wait=false);
    bool        writeFloatArray(const float*,od_int64,bool wait=false);
    bool        writeDoubleArray(const double*,od_int64,bool wait=false);

    enum ReadStatus { ReadOK, Timeout, ReadError };
    bool        readChar(char&) const;
    bool        readShort(short&) const;
    bool        readInt32(od_int32&) const;
    bool        readInt64(od_int64&) const;
    bool        readFloat(float&) const;
    bool        readDouble(double&) const;
    bool        read(BufferString&) const;
    bool        read(IOPar&) const;
    ReadStatus  read(Network::RequestPacket&) const;

    ReadStatus  readArray(void*,od_int64) const;
    bool        readShortArray(short*,od_int64) const;
    bool        readInt32Array(od_int32*,od_int64) const;
    bool        readInt64Array(od_int64*,od_int64) const;
    bool        readFloatArray(float*,od_int64) const;
    bool        readDoubleArray(double*,od_int64) const;

    Notifier<Socket> disconnected; 
    Notifier<Socket> readyRead;    
    const void*                 thread() const { return thread_; }
private:

    bool                        waitForConnected() const;
    bool                        waitForNewData() const;
    bool                        waitForWrite(bool all) const;

    mutable uiString            errmsg_;
    mutable Threads::Lock       lock_;

    int                         timeout_;
    bool                        noeventloop_;

    mQtclass(QTcpSocket)*       qtcpsocket_;
    bool                        ownssocket_;

    mQtclass(QTcpSocketComm)*   socketcomm_;

    const void*                 thread_;
};


} // namespace Network


#endif