class Poco::Net::StreamSocket

Overview

This class provides an interface to a TCP stream socket. More…

#include <StreamSocket.h>

class StreamSocket: public Poco::Net::Socket
{
public:
    // construction

    StreamSocket();
    StreamSocket(const SocketAddress& address);
    StreamSocket(IPAddress::Family family);
    StreamSocket(const Socket& socket);
    StreamSocket(SocketImpl* pImpl);

    // methods

    StreamSocket&
    operator=(const Socket& socket);

    void
    connect(const SocketAddress& address);

    void
    connect(
        const SocketAddress& address,
        const Poco::Timespan& timeout
        );

    void
    connectNB(const SocketAddress& address);

    void
    shutdownReceive();

    void
    shutdownSend();

    void
    shutdown();

    int
    sendBytes(
        const void* buffer,
        int length,
        int flags = 0
        );

    int
    sendBytes(Poco::FIFOBuffer& buffer);

    int
    receiveBytes(
        void* buffer,
        int length,
        int flags = 0
        );

    int
    receiveBytes(Poco::FIFOBuffer& buffer);

    void
    sendUrgent(unsigned char data);
};

// direct descendants

class DialogSocket;
class WebSocket;

Inherited Members

public:
    // typedefs

    typedef std::vector<Socket> SocketList;

    // enums

    enum SelectMode;

    // 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:
    // methods

    poco_socket_t
    sockfd() const;

Detailed Documentation

This class provides an interface to a TCP stream socket.

Construction

StreamSocket()

Creates an unconnected stream socket.

Before sending or receiving data, the socket must be connected with a call to connect().

StreamSocket(const SocketAddress& address)

Creates a stream socket and connects it to the socket specified by address.

StreamSocket(IPAddress::Family family)

Creates an unconnected stream socket for the given address family.

This is useful if certain socket options (like send and receive buffer) sizes, that must be set before connecting the socket, will be set later on.

StreamSocket(const Socket& socket)

Creates the StreamSocket with the SocketImpl from another socket.

The SocketImpl must be a StreamSocketImpl, otherwise an InvalidArgumentException will be thrown.

StreamSocket(SocketImpl* pImpl)

Creates the Socket and attaches the given SocketImpl.

The socket takes owership of the SocketImpl.

The SocketImpl must be a StreamSocketImpl, otherwise an InvalidArgumentException will be thrown.

Methods

StreamSocket&
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.

void
connect(const SocketAddress& address)

Initializes the socket and establishes a connection to the TCP server at the given address.

Can also be used for UDP sockets. In this case, no connection is established. Instead, incoming and outgoing packets are restricted to the specified address.

void
connect(
    const SocketAddress& address,
    const Poco::Timespan& timeout
    )

Initializes the socket, sets the socket timeout and establishes a connection to the TCP server at the given address.

void
connectNB(const SocketAddress& address)

Initializes the socket and establishes a connection to the TCP server at the given address.

Prior to opening the connection the socket is set to nonblocking mode.

void
shutdownReceive()

Shuts down the receiving part of the socket connection.

void
shutdownSend()

Shuts down the sending part of the socket connection.

void
shutdown()

Shuts down both the receiving and the sending part of the socket connection.

int
sendBytes(
    const void* buffer,
    int length,
    int flags = 0
    )

Sends the contents of the given buffer through the socket.

Returns the number of bytes sent, which may be less than the number of bytes specified.

Certain socket implementations may also return a negative value denoting a certain condition.

int
sendBytes(Poco::FIFOBuffer& buffer)

Sends the contents of the given buffer through the socket.

FIFOBuffer has writable/readable transition notifications which may be enabled to notify the caller when the buffer transitions between empty, partially full and full states.

Returns the number of bytes sent, which may be less than the number of bytes specified.

Certain socket implementations may also return a negative value denoting a certain condition.

int
receiveBytes(
    void* buffer,
    int length,
    int flags = 0
    )

Receives data from the socket and stores it in buffer.

Up to length bytes are received.

Returns the number of bytes received. A return value of 0 means a graceful shutdown of the connection from the peer.

Throws a TimeoutException if a receive timeout has been set and nothing is received within that interval. Throws a NetException (or a subclass) in case of other errors.

int
receiveBytes(Poco::FIFOBuffer& buffer)

Receives data from the socket and stores it in buffer.

Up to length bytes are received. FIFOBuffer has writable/readable transition notifications which may be enabled to notify the caller when the buffer transitions between empty, partially full and full states.

Returns the number of bytes received. A return value of 0 means a graceful shutdown of the connection from the peer.

Throws a TimeoutException if a receive timeout has been set and nothing is received within that interval. Throws a NetException (or a subclass) in case of other errors.

void
sendUrgent(unsigned char data)

Sends one byte of urgent data through the socket.

The data is sent with the MSG_OOB flag.

The preferred way for a socket to receive urgent data is by enabling the SO_OOBINLINE option.