ConnectableSocket.h

Go to the documentation of this file.

// ConnectableSocket.h -- interface for the ConnectableSocket class

#ifndef CONNECTABLESOCKET_H_
#define CONNECTABLESOCKET_H_

#ifdef _MSC_VER
#pragma once
#endif // MSVC

#include "Socket.h"

// ConnectableSocket

// Contains the behaviors common to all connectable sockets.

class ConnectableSocket : public Socket
{
public:
        // Socket state mask
        enum IoState
        {
                state_eof = 0x01,
                state_failed = 0x02,
                state_raise_event = 0x04
        };

        // standard c++ iostream inserter
        std::ostream& operator<<( std::ostream& stream) const;

        // Connecting.
        void connectTo(const SocketAddress& address);

        // Read from the socket stream into the buffer
        int read( void* buffer, int bytes);

        // Write the buffer to the socket stream.
        int write(const void* buffer, int bytes);

        // End of stream verification.
        bool isEof() const;
        bool isOk() const;
        bool isGood() const;


        // Accessors for end of stream notification
        bool eventOnEof() const;
        void eventOnEof(bool flag);

        // Clears the socket
        void clear();

        // Receive from the socket using the specified buffer
        int receiveFrom(SocketAddress& address,void* buffer,int bytes);

        // Peer address.
        SocketAddress peerAddress() const;

        // Testing.
        bool isConnected() const;

protected:
        // Hidden constructors
        ConnectableSocket(SOCKET socketHandle);
        ConnectableSocket(int type,int domain,int protocol = 0);

        // Connects the socket to the address
        void connectTo(sockaddr* address,int size);

        // Retrieve whether the state is equal to the passed in state mask
        bool getFlags(short mask) const;
};


#endif // CONNECTABLESOCKET_H_

---