NQclass.h

Go to the documentation of this file.

#ifndef __NETWORKQUEUE_H_INCLUDED__
#define __NETWORKQUEUE_H_INCLUDED__



class CNetworkQueue
{
    friend class CNQMessage; // (---)
    friend class CNQMessageBuffers; // (-!-)
public:
    CNetworkQueue();

    ~CNetworkQueue();

    // reference handling to get/putback CNQMessage buffers to work with
    CNQMessage  *createMsg();

    bool        freeMsg( CNQMessage *ref);
    
    bool        addPeer(UINT32 ip_hostorder, UINT32 port_hostorder);
    
    bool        removePeer(UINT32 ip_hostorder, UINT32 port_hostorder);
    
    bool        create( const ONECHAR *ip_remote_peer, UINT16 portnumber_remote, UINT16 portnumber_local ); // dotted IP address of remote peer
    // closes the Networkqueue and deinitializes peer connection
    bool        close();

    
    bool        sendMsgTo( CNQMessage *msg, UINT32 ip_hostorder, UINT16 port_hostorder);

    bool        sendMsgTo( CNQMessage *msg, UINT32 ip_hostorder, UINT16 port_hostorder, const NQ_TIMEVAL &timeout);

    bool        recvMsg( CNQMessage **newmsg ); // instant return
    
    bool        recvMsg( CNQMessage **newmsg, const NQ_TIMEVAL &timeout ); // event-based, wait until timeout

    bool        sendRecvMsg(CNQMessage **response, CNQMessage *request, UINT32 ip_hostorder, UINT16 port_hostorder, const NQ_TIMEVAL &timeout);

    bool        getStatistics( NQ_STATISTICS &stats );

    
    //          get the last error code 
    UINT32      getLastError();
    //          get the error string of the last occured error code
    bool        getLastErrorString( ONECHAR *buffer, UINT32 buflength);
    
    // should not be public in principle!
    // public because called from platform.cpp non-class thread function
    // one task or thread in order to do sending and receiving from peer
    
    void        SendProcessTask();
    
    void        ReceiveProcessTask();
    
    //void PrintQueueSizes(); // was debug, removed Oct 17, 2007 SW

protected:

private:

    bool                sendMsgToInternal( UINT32 ip_hostorder, UINT16 port_hostorder, CNQMessage *msg, HANDLE recv_notify_sem);

    CNQMessage          *obtainReference();
    bool                incrementReferenceCount( CNQMessage *ref );
    bool                putbackReference( CNQMessage *ref);

    
    // pooling of message buffers
    CNQMessagePool      bufs;

    // internal statistics buffer
    NQ_STATISTICS       m_stats;

    socktype            m_socket;
    UINT32              m_iLastError;
    INT32               m_iLastSystemError;

    // semaphores to communicate with send and receive tasks/threads    
    HANDLE              m_sendSemaphore;
    HANDLE              m_receiveSemaphore;
    
    // queues to communicate with send and receive tasks/threads
    CNQPacketQueue      m_SendPacketQueue;
    CNQPacketQueue      m_ReceivePacketQueue;

    // dedicated queues for special handling
    CNQPacketQueue      m_AckPacketWaitingQueue;

    CNQPacketQueue      m_ReceiveResponseSemaphorePacketQueue;
    CNQResponseWaitQueue    m_ResponseWaitQueue;

    // list of allowed peers
    CNQPeerList         m_PeerList;

    bool                m_bSuccessfulInitialized;

    // thread/task stuff
    HANDLE              m_hSendThread;
    HANDLE              m_hReceiveThread;

    volatile bool       m_bShutdownSendThread;
    volatile bool       m_bSendThreadRunning;

    volatile bool       m_bShutdownReceiveThread;
    volatile bool       m_bReceiveThreadRunning;

    // 'unique' request id
    UINT16              m_iNextRequestId;
};


#endif //__NETWORKQUEUE_H_INCLUDED__

---