Socket.h

Go to the documentation of this file.

// Socket.h: interface for the Socket class

#ifndef SOCKET_H_
#define SOCKET_H_

#ifdef _MSC_VER
#pragma once
#endif // MSVC

#include "SocketIncludes.h"
#include "SocketAddress.h"


// SocketOptions

// enumeration defining the Socket options that can be set


// Socket

// Cntains the behaviors common to all sockets.

class Socket
{
public:

        enum SocketShutdownMode
        {
                ShutdownReceive = 0x00,         // Disable sending on this socket.
                ShutdownSend = 0x01,            // Disable receiving on this socket. 
                ShutdownBoth = 0x02                     // Disable both sending and receiving on this socket
        };

        // Destructor is virutal for subclass specific cleanup
        virtual ~Socket();

        // Comparison to another Socket
        bool operator==(const Socket& socket) const throw();
        bool operator<(const Socket& socket) const throw();

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

        // Check the open flag
        bool isOpen() const throw();

        // Close the Socket
        void close();

        // Retrieve whether the Socket will close the native socket on destruction
        bool isAutoClosing() const throw();

        // Specify whether or not the destructor will close the native socket
        void setToAutoClose(bool autoClose) throw();

        // Associates a local address with a socket
        void bind(const SocketAddress& address);

        // Shutsdown socket (with code of ShutdownSend)
        void shutdownSocketSends();

        // Shutsdown socket (with code of ShutdownReceive)
        void shutdownSocketReceives();

        // Shutsown socket (with code of ShutdownBoth)
        void shutdown();

        // Shutdown socket (see SocketShutdown enum)
        void shutdown(SocketShutdownMode code);

        // The type of socket (ie, SOCK_STREAM)
        int getSocketType() const;

        // Get a SocketAddress object descibing the socket
        SocketAddress getSocketAddress() const;

        // Convert the Socket to the native OS socket descriptor
        operator SOCKET() const throw();

        // Accessors for the native OS socket descriptor
        SOCKET getDescriptor() const throw();
        void setDescriptor(SOCKET socketHandle) throw();

        // Accessors for the socket's receiving buffer size.
        int getReceivingBufferSize() const;
        void setReceivingBufferSize(int size);

        // Accessors for the socket's sending buffer size.
        int getSendingBufferSize() const;
        void setSendingBufferSize(int newBufferSize);

        // Retrieves error status and clears the status
        int getAndClearErrorStatus();

        // Retrieve the length of time the socket will wait for unsent data
        // before the socket is closed and whether it is set
        bool getLingerInformation(int& seconds) const;

        // Specify the length of time to wait for unsent data before a socket is closed
        void setLingerInformation(bool flag,int seconds);

        // Retrieve whether routing is enabled
        // The default option is false for the SO_DONTROUTE
        bool getRouting() const;

        // Specify whether the socket should use routing
        void setRouting(bool flag);

        // Retrieve whether the address to which this socket is bound can be used by others
        bool canLocalAddressesBeReused() const;

        // Specify whether the address to which this socket is bound can be used by others
        void setReuseLocalAddresses(bool flag);
protected:
        // Construct from the native OS socket descriptor
        Socket(SOCKET descriptor);

        // Construct a Socket that is bound to a specific service
        Socket(int type,int domain,int protocol = 0);

        // Close and reopen the TcpSocket (all active connections will be lost)
        void reset(int type,int domain,int protocol = 0);
    
        // Associates a local address with a socket
        void bind(sockaddr* address,int size);

        // Accessor to set the socket name
        void name(sockaddr* address,int& size) const;

        // Methods to set varios socket option
        // See the berkley Sockets documentation on what all of the options are
        int getOption(int code) const;
        void getOption(int code,void* storage,int& size) const;
        void setOption(int code,int value);     
        void setOption(int code,void* storage,int size);

        // Boolean methods for convenience
        bool getBoolOption(int code) const;
        void setBoolOption(int code,bool flag);

        // Native operating system socket handle
        SOCKET socketHandle;

        // Flage to close the socket on destruction
        bool autoClosing;

        // State mask for IO
        short flags_;
};


#endif // SOCKET_H_

---