root/trunk/dep/include/sockets/StreamSocket.h @ 2

#ifndef _StreamSocket_H
#define _StreamSocket_H

#include "Socket.h"


#ifdef SOCKETS_NAMESPACE
namespace SOCKETS_NAMESPACE {
#endif


/** SOCK_STREAM Socket base class.
        \ingroup basic */
class StreamSocket : public Socket
{
public:
        StreamSocket(ISocketHandler& );
        ~StreamSocket();

        /** Socket should Check Connect on next write event from select(). */
        void SetConnecting(bool = true);

        /** Check connecting flag.
                \return true if the socket is still trying to connect */
        bool Connecting();

        /** Returns true when socket file descriptor is valid,
                socket connection is established, and socket is not about to
                be closed. */
        bool Ready();

        /** Set timeout to use for connection attempt.
                \param x Timeout in seconds */
        void SetConnectTimeout(int x);

        /** Return number of seconds to wait for a connection.
                \return Connection timeout (seconds) */
        int GetConnectTimeout();

        /** Set flush before close to make a tcp socket completely empty its
                output buffer before closing the connection. */
        void SetFlushBeforeClose(bool = true);

        /** Check flush before status.
                \return true if the socket should send all data before closing */
        bool GetFlushBeforeClose();

        /** Define number of connection retries (tcp only).
            n = 0 - no retry
            n > 0 - number of retries
            n = -1 - unlimited retries */
        void SetConnectionRetry(int n);

        /** Get number of maximum connection retries (tcp only). */
        int GetConnectionRetry();

        /** Increase number of actual connection retries (tcp only). */
        void IncreaseConnectionRetries();

        /** Get number of actual connection retries (tcp only). */
        int GetConnectionRetries();

        /** Reset actual connection retries (tcp only). */
        void ResetConnectionRetries();

        // LIST_CALLONCONNECT

        /** Instruct socket to call OnConnect callback next sockethandler cycle. */
        void SetCallOnConnect(bool x = true);

        /** Check call on connect flag.
                \return true if OnConnect() should be called a.s.a.p */
        bool CallOnConnect();

        // LIST_RETRY

        /** Set flag to initiate a connection attempt after a connection timeout. */
        void SetRetryClientConnect(bool x = true);

        /** Check if a connection attempt should be made.
                \return true when another attempt should be made */
        bool RetryClientConnect();

        /** Called after OnRead if socket is in line protocol mode.
                \sa SetLineProtocol */
        /** Enable the OnLine callback. Do not create your own OnRead
         * callback when using this. */
        virtual void SetLineProtocol(bool = true);

        /** Check line protocol mode.
                \return true if socket is in line protocol mode */
        bool LineProtocol();

        /** Set shutdown status. */
        void SetShutdown(int);

        /** Get shutdown status. */
        int GetShutdown();

        /** Returns IPPROTO_TCP or IPPROTO_SCTP */
        virtual int Protocol() = 0;

protected:
        StreamSocket(const StreamSocket& ) {} // copy constructor

private:
        StreamSocket& operator=(const StreamSocket& ) { return *this; } // assignment operator

        bool m_bConnecting; ///< Flag indicating connection in progress
        int m_connect_timeout; ///< Connection timeout (seconds)
        bool m_flush_before_close; ///< Send all data before closing (default true)
        int m_connection_retry; ///< Maximum connection retries (tcp)
        int m_retries; ///< Actual number of connection retries (tcp)
        bool m_call_on_connect; ///< OnConnect will be called next ISocketHandler cycle if true
        bool m_b_retry_connect; ///< Try another connection attempt next ISocketHandler cycle
        bool m_line_protocol; ///< Line protocol mode flag
        int m_shutdown; ///< Shutdown status
};


#ifdef SOCKETS_NAMESPACE
} // namespace SOCKETS_NAMESPACE {
#endif


#endif // _StreamSocket_H