Library: Net
Package: Sockets
Header: Poco/Net/SocketImpl.h
This class encapsulates the Berkeley sockets API.
Subclasses implement specific socket types like stream or datagram sockets.
You should not create any instances of this class.
Direct Base Classes: Poco::RefCountedObject
All Base Classes: Poco::RefCountedObject
Known Derived Classes: DatagramSocketImpl, ICMPSocketImpl, RawSocketImpl, ServerSocketImpl, StreamSocketImpl, SecureServerSocketImpl, SecureStreamSocketImpl
Member Functions: acceptConnection, address, available, bind, bind6, close, connect, connectNB, error, getBlocking, getBroadcast, getKeepAlive, getLinger, getNoDelay, getOOBInline, getOption, getRawOption, getReceiveBufferSize, getReceiveTimeout, getReuseAddress, getReusePort, getSendBufferSize, getSendTimeout, init, initSocket, initialized, ioctl, lastError, listen, peerAddress, poll, receiveBytes, receiveFrom, reset, secure, sendBytes, sendTo, sendUrgent, setBlocking, setBroadcast, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setRawOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, socketError, sockfd
Inherited Functions: duplicate, referenceCount, release
SELECT_READ = 1
SELECT_WRITE = 2
SELECT_ERROR = 4
SocketImpl();
Creates a SocketImpl.
SocketImpl(
int sockfd
);
Creates a SocketImpl using the given native socket.
virtual ~SocketImpl();
Destroys the SocketImpl. Closes the socket if it is still open.
virtual SocketImpl * acceptConnection(
SocketAddress & clientAddr
);
Get the next completed connection from the socket's completed connection queue.
If the queue is empty, waits until a connection request completes.
Returns a new TCP socket for the connection with the client.
The client socket's address is returned in clientAddr.
virtual SocketAddress address();
Returns the IP address and port number of the socket.
virtual int available();
Returns the number of bytes available that can be read without causing the socket to block.
virtual void bind(
const SocketAddress & address,
bool reuseAddress = false
);
Bind a local address to the socket.
This is usually only done when establishing a server socket. TCP clients should not bind a socket to a specific address.
If reuseAddress is true, sets the SO_REUSEADDR socket option.
virtual void bind6(
const SocketAddress & address,
bool reuseAddress = false,
bool ipV6Only = false
);
Bind a local IPv6 address to the socket.
This is usually only done when establishing a server socket. TCP clients should not bind a socket to a specific address.
If reuseAddress is true, sets the SO_REUSEADDR socket option.
The given address must be an IPv6 address. The IPPROTO_IPV6/IPV6_V6ONLY option is set on the socket according to the ipV6Only parameter.
If the library has not been built with IPv6 support, a Poco::NotImplementedException will be thrown.
virtual void close();
Close the socket.
virtual 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.
virtual 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.
virtual 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.
virtual 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!
bool getBroadcast();
Returns the value of the SO_BROADCAST socket option.
bool getKeepAlive();
Returns the value of the SO_KEEPALIVE socket option.
void getLinger(
bool & on,
int & seconds
);
Returns the value of the SO_LINGER socket option.
bool getNoDelay();
Returns the value of the TCP_NODELAY socket option.
bool getOOBInline();
Returns the value of the SO_OOBINLINE socket option.
void getOption(
int level,
int option,
int & value
);
Returns the value of the socket option specified by level and option.
void getOption(
int level,
int option,
unsigned & value
);
Returns the value of the socket option specified by level and option.
void getOption(
int level,
int option,
unsigned char & value
);
Returns the value of the socket option specified by level and option.
void getOption(
int level,
int option,
Poco::Timespan & value
);
Returns the value of the socket option specified by level and option.
void getOption(
int level,
int option,
IPAddress & value
);
Returns the value of the socket option specified by level and option.
virtual void getRawOption(
int level,
int option,
void * value,
socklen_t & length
);
Returns the value of the socket option specified by level and option.
virtual int getReceiveBufferSize();
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.
virtual Poco::Timespan getReceiveTimeout();
Returns the receive timeout for the socket.
The returned timeout may be different than the timeout previously set with setReceiveTimeout(), as the system is free to adjust the value.
bool getReuseAddress();
Returns the value of the SO_REUSEADDR socket option.
bool getReusePort();
Returns the value of the SO_REUSEPORT socket option.
Returns false if the socket implementation does not support SO_REUSEPORT.
virtual int getSendBufferSize();
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.
virtual Poco::Timespan getSendTimeout();
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.
bool initialized() const;
Returns true if and only if the underlying socket is initialized.
void ioctl(
unsigned long request,
int & arg
);
A wrapper for the ioctl system call.
void ioctl(
unsigned long request,
void * arg
);
A wrapper for the ioctl system call.
virtual void listen(
int backlog = 64
);
Puts the socket into listening state.
The socket becomes a passive socket that can accept incoming connection requests.
The backlog argument specifies the maximum number of connections that can be queued for this socket.
virtual SocketAddress peerAddress();
Returns the IP address and port number of the peer socket.
virtual bool poll(
const Poco::Timespan & timeout,
int mode
);
Determines the status of the socket, using a call to 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.
virtual 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.
Certain socket implementations may also return a negative value denoting a certain condition.
virtual int receiveFrom(
void * buffer,
int length,
SocketAddress & address,
int flags = 0
);
Receives data from the socket and stores it in buffer. Up to length bytes are received. Stores the address of the sender in address.
Returns the number of bytes received.
virtual bool secure() const;
Returns true if and only if the socket's connection is secure (using SSL or TLS).
virtual 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.
virtual int sendTo(
const void * buffer,
int length,
const SocketAddress & address,
int flags = 0
);
Sends the contents of the given buffer through the socket to the given address.
Returns the number of bytes sent, which may be less than the number of bytes specified.
virtual 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.
virtual void setBlocking(
bool flag
);
Sets the socket in blocking mode if flag is true, disables blocking mode if flag is false.
void setBroadcast(
bool flag
);
Sets the value of the SO_BROADCAST socket option.
void setKeepAlive(
bool flag
);
Sets the value of the SO_KEEPALIVE socket option.
void setLinger(
bool on,
int seconds
);
Sets the value of the SO_LINGER socket option.
void setNoDelay(
bool flag
);
Sets the value of the TCP_NODELAY socket option.
void setOOBInline(
bool flag
);
Sets the value of the SO_OOBINLINE socket option.
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.
virtual void setRawOption(
int level,
int option,
const void * value,
socklen_t length
);
Sets the socket option specified by level and option to the given time value.
virtual void setReceiveBufferSize(
int size
);
Sets the size of the receive buffer.
virtual 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.
void setReuseAddress(
bool flag
);
Sets 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.
virtual void setSendBufferSize(
int size
);
Sets the size of the send buffer.
virtual void setSendTimeout(
const Poco::Timespan & timeout
);
Sets the send timeout for the socket.
virtual void shutdown();
Shuts down both the receiving and the sending part of the socket connection.
virtual void shutdownReceive();
Shuts down the receiving part of the socket connection.
virtual void shutdownSend();
Shuts down the sending part of the socket connection.
int socketError();
Returns the value of the SO_ERROR socket option.
int sockfd() const;
Returns the socket descriptor for the underlying native socket.
static void error();
Throws an appropriate exception for the last error.
static void error(
const std::string & arg
);
Throws an appropriate exception for the last error.
static void error(
int code
);
Throws an appropriate exception for the given error code.
static void error(
int code,
const std::string & arg
);
Throws an appropriate exception for the given error code.
virtual void init(
int af
);
Creates the underlying native socket.
Subclasses must implement this method so that it calls initSocket() with the appropriate arguments.
The default implementation creates a stream socket.
void initSocket(
int af,
int type,
int proto = 0
);
Creates the underlying native socket.
The first argument, af, specifies the address family used by the socket, which should be either AF_INET or AF_INET6.
The second argument, type, specifies the type of the socket, which can be one of SOCK_STREAM, SOCK_DGRAM or SOCK_RAW.
The third argument, proto, is normally set to 0, except for raw sockets.
static int lastError();
Returns the last error code.
void reset(
int fd = - 1
);
Allows subclasses to set the socket manually, if and only if no valid socket is set yet.