class Poco::Net::Socket

Overview

Socket is the common base class for StreamSocket, ServerSocket, DatagramSocket and other socket classes. More…

#include <Socket.h>

class Socket
{
public:
    // typedefs

    typedef std::vector<Socket> SocketList;

    // enums

    enum SelectMode;

    // construction

    Socket();
    Socket(const Socket& socket);

    // methods

    Socket&
    operator=(const Socket& socket);

    bool
    operator==(const Socket& socket) const;

    bool
    operator!=(const Socket& socket) const;

    bool
    operator<(const Socket& socket) const;

    bool
    operator<=(const Socket& socket) const;

    bool
    operator>(const Socket& socket) const;

    bool
    operator>=(const Socket& socket) const;

    void
    close();

    bool
    poll(
        const Poco::Timespan& timeout,
        int mode
        ) const;

    int
    available() const;

    void
    setSendBufferSize(int size);

    int
    getSendBufferSize() const;

    void
    setReceiveBufferSize(int size);

    int
    getReceiveBufferSize() const;

    void
    setSendTimeout(const Poco::Timespan& timeout);

    Poco::Timespan
    getSendTimeout() const;

    void
    setReceiveTimeout(const Poco::Timespan& timeout);

    Poco::Timespan
    getReceiveTimeout() const;

    void
    setOption(
        int level,
        int option,
        int value
        );

    void
    setOption(
        int level,
        int option,
        unsigned value
        );

    void
    setOption(
        int level,
        int option,
        unsigned char value
        );

    void
    setOption(
        int level,
        int option,
        const Poco::Timespan& value
        );

    void
    setOption(
        int level,
        int option,
        const IPAddress& value
        );

    void
    getOption(
        int level,
        int option,
        int& value
        ) const;

    void
    getOption(
        int level,
        int option,
        unsigned& value
        ) const;

    void
    getOption(
        int level,
        int option,
        unsigned char& value
        ) const;

    void
    getOption(
        int level,
        int option,
        Poco::Timespan& value
        ) const;

    void
    getOption(
        int level,
        int option,
        IPAddress& value
        ) const;

    void
    setLinger(
        bool on,
        int seconds
        );

    void
    getLinger(
        bool& on,
        int& seconds
        ) const;

    void
    setNoDelay(bool flag);

    bool
    getNoDelay() const;

    void
    setKeepAlive(bool flag);

    bool
    getKeepAlive() const;

    void
    setReuseAddress(bool flag);

    bool
    getReuseAddress() const;

    void
    setReusePort(bool flag);

    bool
    getReusePort() const;

    void
    setOOBInline(bool flag);

    bool
    getOOBInline() const;

    void
    setBlocking(bool flag);

    bool
    getBlocking() const;

    SocketAddress
    address() const;

    SocketAddress
    peerAddress() const;

    SocketImpl*
    impl() const;

    bool
    secure() const;

    void
    init(int af);

    static
    int
    select(
        SocketList& readList,
        SocketList& writeList,
        SocketList& exceptList,
        const Poco::Timespan& timeout
        );

    static
    bool
    supportsIPv4();

    static
    bool
    supportsIPv6();

protected:
    // construction

    Socket(SocketImpl* pImpl);

    // methods

    poco_socket_t
    sockfd() const;
};

// direct descendants

class DatagramSocket;
class ICMPSocket;
class RawSocket;
class ServerSocket;
class StreamSocket;

Detailed Documentation

Socket is the common base class for StreamSocket, ServerSocket, DatagramSocket and other socket classes.

It provides operations common to all socket types.

Construction

Socket()

Creates an uninitialized socket.

Socket(const Socket& socket)

Copy constructor.

Attaches the SocketImpl from the other socket and increments the reference count of the SocketImpl.

Socket(SocketImpl* pImpl)

Creates the Socket and attaches the given SocketImpl.

The socket takes ownership of the SocketImpl.

Methods

Socket&
operator=(const Socket& socket)

Assignment operator.

Releases the socket’s SocketImpl and attaches the SocketImpl from the other socket and increments the reference count of the SocketImpl.

bool
operator==(const Socket& socket) const

Returns true if both sockets share the same SocketImpl, false otherwise.

bool
operator!=(const Socket& socket) const

Returns false if both sockets share the same SocketImpl, true otherwise.

bool
operator<(const Socket& socket) const

Compares the SocketImpl pointers.

bool
operator<=(const Socket& socket) const

Compares the SocketImpl pointers.

bool
operator>(const Socket& socket) const

Compares the SocketImpl pointers.

bool
operator>=(const Socket& socket) const

Compares the SocketImpl pointers.

void
close()

Closes the socket.

bool
poll(
    const Poco::Timespan& timeout,
    int mode
    ) const

Determines the status of the socket, using a call to poll() or select().

The mode argument is constructed by combining the values of the SelectMode enumeration.

Returns true if the next operation corresponding to mode will not block, false otherwise.

int
available() const

Returns the number of bytes available that can be read without causing the socket to block.

void
setSendBufferSize(int size)

Sets the size of the send buffer.

int
getSendBufferSize() const

Returns the size of the send buffer.

The returned value may be different than the value previously set with setSendBufferSize(), as the system is free to adjust the value.

void
setReceiveBufferSize(int size)

Sets the size of the receive buffer.

int
getReceiveBufferSize() const

Returns the size of the receive buffer.

The returned value may be different than the value previously set with setReceiveBufferSize(), as the system is free to adjust the value.

void
setSendTimeout(const Poco::Timespan& timeout)

Sets the send timeout for the socket.

Poco::Timespan
getSendTimeout() const

Returns the send timeout for the socket.

The returned timeout may be different than the timeout previously set with setSendTimeout(), as the system is free to adjust the value.

void
setReceiveTimeout(const Poco::Timespan& timeout)

Sets the send timeout for the socket.

On systems that do not support SO_RCVTIMEO, a workaround using poll() is provided.

Poco::Timespan
getReceiveTimeout() const

Returns the receive timeout for the socket.

The returned timeout may be different than the timeout previously set with getReceiveTimeout(), as the system is free to adjust the value.

void
setOption(
    int level,
    int option,
    int value
    )

Sets the socket option specified by level and option to the given integer value.

void
setOption(
    int level,
    int option,
    unsigned value
    )

Sets the socket option specified by level and option to the given integer value.

void
setOption(
    int level,
    int option,
    unsigned char value
    )

Sets the socket option specified by level and option to the given integer value.

void
setOption(
    int level,
    int option,
    const Poco::Timespan& value
    )

Sets the socket option specified by level and option to the given time value.

void
setOption(
    int level,
    int option,
    const IPAddress& value
    )

Sets the socket option specified by level and option to the given time value.

void
getOption(
    int level,
    int option,
    int& value
    ) const

Returns the value of the socket option specified by level and option.

void
getOption(
    int level,
    int option,
    unsigned& value
    ) const

Returns the value of the socket option specified by level and option.

void
getOption(
    int level,
    int option,
    unsigned char& value
    ) const

Returns the value of the socket option specified by level and option.

void
getOption(
    int level,
    int option,
    Poco::Timespan& value
    ) const

Returns the value of the socket option specified by level and option.

void
getOption(
    int level,
    int option,
    IPAddress& value
    ) const

Returns the value of the socket option specified by level and option.

void
setLinger(
    bool on,
    int seconds
    )

Sets the value of the SO_LINGER socket option.

void
getLinger(
    bool& on,
    int& seconds
    ) const

Returns the value of the SO_LINGER socket option.

void
setNoDelay(bool flag)

Sets the value of the TCP_NODELAY socket option.

bool
getNoDelay() const

Returns the value of the TCP_NODELAY socket option.

void
setKeepAlive(bool flag)

Sets the value of the SO_KEEPALIVE socket option.

bool
getKeepAlive() const

Returns the value of the SO_KEEPALIVE socket option.

void
setReuseAddress(bool flag)

Sets the value of the SO_REUSEADDR socket option.

bool
getReuseAddress() const

Returns the value of the SO_REUSEADDR socket option.

void
setReusePort(bool flag)

Sets the value of the SO_REUSEPORT socket option.

Does nothing if the socket implementation does not support SO_REUSEPORT.

bool
getReusePort() const

Returns the value of the SO_REUSEPORT socket option.

Returns false if the socket implementation does not support SO_REUSEPORT.

void
setOOBInline(bool flag)

Sets the value of the SO_OOBINLINE socket option.

bool
getOOBInline() const

Returns the value of the SO_OOBINLINE socket option.

void
setBlocking(bool flag)

Sets the socket in blocking mode if flag is true, disables blocking mode if flag is false.

bool
getBlocking() const

Returns the blocking mode of the socket.

This method will only work if the blocking modes of the socket are changed via the setBlocking method!

SocketAddress
address() const

Returns the IP address and port number of the socket.

SocketAddress
peerAddress() const

Returns the IP address and port number of the peer socket.

SocketImpl*
impl() const

Returns the SocketImpl for this socket.

bool
secure() const

Returns true iff the socket’s connection is secure (using SSL or TLS).

void
init(int af)

Creates the underlying system socket for the given address family.

Normally, this method should not be called directly, as socket creation will be handled automatically. There are a few situations where calling this method after creation of the Socket object makes sense. One example is setting a socket option before calling bind() on a ServerSocket.

static
int
select(
    SocketList& readList,
    SocketList& writeList,
    SocketList& exceptList,
    const Poco::Timespan& timeout
    )

Determines the status of one or more sockets, using a call to select().

ReadList contains the list of sockets which should be checked for readability.

WriteList contains the list of sockets which should be checked for writeability.

ExceptList contains a list of sockets which should be checked for a pending error.

Returns the number of sockets ready.

After return,

* readList contains those sockets ready for reading,
* writeList contains those sockets ready for writing,
* exceptList contains those sockets with a pending error.

If the total number of sockets passed in readList, writeList and exceptList is zero, select() will return immediately and the return value will be 0.

If one of the sockets passed to select() is closed while select() runs, select will return immediately. However, the closed socket will not be included in any list. In this case, the return value may be greater than the sum of all sockets in all list.

static
bool
supportsIPv4()

Returns true if the system supports IPv4.

static
bool
supportsIPv6()

Returns true if the system supports IPv6.

poco_socket_t
sockfd() const

Returns the socket descriptor for this socket.