Library: NetSSL_OpenSSL
Package: SSLSockets
Header: Poco/Net/SecureStreamSocketImpl.h
This class implements a SSL stream socket.
Direct Base Classes: StreamSocketImpl
All Base Classes: SocketImpl, StreamSocketImpl, Poco::RefCountedObject
Member Functions: acceptConnection, acceptSSL, bind, close, connect, connectNB, connectSSL, context, error, getPeerHostName, lastError, listen, peerCertificate, receiveBytes, receiveFrom, sendBytes, sendTo, sendUrgent, setPeerHostName, shutdown, shutdownReceive, shutdownSend
Inherited Functions: acceptConnection, address, available, bind, close, connect, connectNB, duplicate, 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, referenceCount, release, reset, sendBytes, sendTo, sendUrgent, setBlocking, setBroadcast, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setRawOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, socketError, sockfd
SecureStreamSocketImpl(
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
SecureStreamSocketImpl(
StreamSocketImpl * pStreamSocket,
Context::Ptr pContext
);
Creates the SecureStreamSocketImpl.
Destroys the SecureStreamSocketImpl.
SocketImpl * acceptConnection(
SocketAddress & clientAddr
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
void acceptSSL();
Performs a SSL server-side handshake.
void bind(
const SocketAddress & address,
bool reuseAddress = false
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::bind()
void close();
Close the socket.
See also: Poco::Net::SocketImpl::close()
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.
See also: Poco::Net::SocketImpl::connect()
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.
See also: Poco::Net::SocketImpl::connect()
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.
See also: Poco::Net::SocketImpl::connectNB()
void connectSSL();
Performs a SSL client-side handshake on an already connected TCP socket.
Context::Ptr context() const;
Returns the SSL context used by this socket.
const std::string & getPeerHostName() const;
Returns the peer host name.
void listen(
int backlog = 64
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::listen()
X509Certificate peerCertificate() const;
Returns the peer's X509 certificate.
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.
See also: Poco::Net::SocketImpl::receiveBytes()
int receiveFrom(
void * buffer,
int length,
SocketAddress & address,
int flags = 0
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::receiveFrom()
int sendBytes(
const void * buffer,
int length,
int flags = 0
);
Sends the contents of the given buffer through the socket. Any specified flags are ignored.
Returns the number of bytes sent, which may be less than the number of bytes specified.
See also: Poco::Net::StreamSocketImpl::sendBytes()
int sendTo(
const void * buffer,
int length,
const SocketAddress & address,
int flags = 0
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendTo()
void sendUrgent(
unsigned char data
);
Not supported by a SecureStreamSocket.
Throws a Poco::InvalidAccessException.
See also: Poco::Net::SocketImpl::sendUrgent()
void setPeerHostName(
const std::string & hostName
);
Sets the peer host name for certificate validation purposes.
void shutdown();
Shuts down the SSL connection.
See also: Poco::Net::SocketImpl::shutdown()
void shutdownReceive();
Shuts down the receiving part of the socket connection.
Since SSL does not support a half shutdown, this does nothing.
See also: Poco::Net::SocketImpl::shutdownReceive()
void shutdownSend();
Shuts down the receiving part of the socket connection.
Since SSL does not support a half shutdown, this does nothing.
See also: Poco::Net::SocketImpl::shutdownSend()
static void error();
static void error(
const std::string & arg
);
static void error(
int code
);
static void error(
int code,
const std::string & arg
);
static int lastError();