SSL/TLS server socket for use in a Reactor environment. More...

#include <tsReactiveTLSServer.h>

Inheritance diagram for ts::ReactiveTLSServer:

[legend]

Collaboration diagram for ts::ReactiveTLSServer:

[legend]

Public Member Functions
	ReactiveTLSServer (Reactor &reactor, TCPServer &socket, const TLSArgs &args, Object *owner=nullptr)
	Constructor with initial arguments.

	ReactiveTLSServer (Reactor &reactor, TCPServer &socket, Object *owner=nullptr)
	Constructor.

virtual void	cancelAccept (bool silent=false)
	Cancel any pending accept operation on this socket.

void	deactivateQueuedOperations (bool silent)
	Deactivate the execution of processQueuedOperations() in the context of a Reactor handler.

const UString &	getCertificatePath () const
	Get the certificate path for the server.

const UString &	getCertificateStore () const
	Get the certificate store.

size_t	getEphemeralRSABits () const
	Get the size in bits of the ephemeral RSA key which is used for the ephemeral self-signed certificate.

const UString &	getKeyPath () const
	Get the private key path for the server.

bool	isOpen () const
	Check if the reactive socket is open.

bool	isOwned ()
	Check if the object is owned.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
bool	isOwned ()
	Check if the object is owned by an object of a given type.

Object *	owner ()
	Get the address of the optional "owner" object which was specified in the constructor.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
OBJECT *	owner ()
	Get the address of the "owner" object which was specified in the constructor.

Reactor &	reactor ()
	Get a reference to the associated reactor.

Report &	report ()
	Get a reference to the associated report.

void	setArgs (const TLSArgs &args)
	Set command line arguments for the server.

void	setCertificatePath (const UString &path)
	Set the certificate path for the server.

void	setCertificateStore (const UString &name)
	Set the certificate store.

void	setEphemeralRSABits (size_t bits)
	Specify to use an ephemeral self-signed certificate with an ephemeral RSA key of the specified size.

void	setKeyPath (const UString &path)
	Set the private key path for the server.

bool	signalQueuedOperations ()
	Trigger the execution of processQueuedOperations() in the context of a Reactor handler.

TCPServer &	socket ()
	Get a reference to the associated server socket.

bool	startAccept (ReactiveTCPServerHandlerInterface *handler, ReactiveTCPConnection &client, const ObjectPtr &user_data=ObjectPtr()) override
	Start the operation of accepting a TCP client.

virtual bool	startClose (ReactiveTCPServerHandlerInterface *handler, bool silent=false, const ObjectPtr &user_data=ObjectPtr())
	Start closing the socket.

Protected Types
using	HandlerType = ReactiveTCPServerHandlerInterface
	Internal shorter name for handler interface.

using	IOQueue = std::list< std::shared_ptr< IOSB > >
	Queues of I/O requests are queues of shared_ptr to IOSB.

using	IOSB = NonBlockingDevice::IOSB
	IOSB shortcut fpr subclasses.

using	IOSet = std::set< std::shared_ptr< IOSB > >
	Unordered set of I/O requests, set of shared_ptr to IOSB.

Protected Member Functions
bool	activateAsynchronousIO ()
	Activate notification for asynchronous I/O.

bool	activateReadReady ()
	Activate read-ready notification for non-blocking I/O.

bool	activateWriteReady ()
	Activate write-ready notification for non-blocking I/O.

bool	cancelAndWaitAsynchronousIO (NonBlockingDevice::IOSB &iosb, bool silent)
	Cancel one specific pending asynchronous I/O and wait for its completion.

void	cancelAsynchronousIO (bool silent)
	Cancel all asynchronous I/O in progress.

template<class REQUEST > requires std::derived_from<REQUEST, ts::Object>
void	cancelQueue (IOQueue &inqueue, IOQueue &outqueue)
	Transfer all requests from one queue to another and mark all I/O as canceled.

void	deactivateAll (bool silent)
	Deactivate all registrations for non-blocking and asynchronous I/O.

void	deactivateAsynchronousIO (bool silent)
	Deactivate notification for asynchronous I/O.

void	deactivateReadReady (bool silent)
	Deactivate read-ready notification for non-blocking I/O.

void	deactivateWriteReady (bool silent)
	Deactivate write-ready notification for non-blocking I/O.

virtual void	handleTCPClientAccepted (ReactiveTCPServer &server, ReactiveTCPConnection &sock, const IPSocketAddress &addr, int error_code, const ObjectPtr &user_data) override
	Handle the reception of TCP data.

virtual void	handleTCPServerClosed (ReactiveTCPServer &server, const ObjectPtr &user_data)
	Handle the completion of closing a TCP server socket.

virtual void	handleTimer (Reactor &reactor, EventId id)
	Handle a timer in a Reactor.

virtual void	handleUserEvent (Reactor &, EventId) override
	Handle a user-defined event in a Reactor.

virtual void	handleWriteReady (Reactor &reactor, EventId id, int error_code)
	Handle a write-ready event in a Reactor.

std::shared_ptr< IOSB >	removeFromQueue (IOQueue &queue, IOSB *iosb)
	Search and remove a shared_ptr to IOSB, based on an IOSB address.

Detailed Description

SSL/TLS server socket for use in a Reactor environment.

The class ReactiveTLSServer is a wrapper around TCPServer to handle reactive I/O.

The actual server socket is a separate object. It is initialized and configured by the application. The application shall not directly call accept(), or close() on this socket and delegate these operations to startAccept() and startClose() in class ReactiveTLSServer.

Member Typedef Documentation

◆ IOQueue

using ts::ReactiveSocketBase::IOQueue = std::list<std::shared_ptr<IOSB> >

protectedinherited

Queues of I/O requests are queues of shared_ptr to IOSB.

This is typically used with non-blocking I/O where we must process requests in order. Send and receive requests are structures which are stored in the react_data of the IOSB.

◆ IOSet

using ts::ReactiveSocketBase::IOSet = std::set<std::shared_ptr<IOSB> >

protectedinherited

Unordered set of I/O requests, set of shared_ptr to IOSB.

This is typically used with asynchronous I/O. The ordering is enforced because I/O are started in order of calls from applications. The completion processing is likely the same, but driven by the system I/O Completion Ports and we must not assume any order. Send and receive requests are structures which are stored in the react_data of the IOSB.

Constructor & Destructor Documentation

◆ ReactiveTLSServer() [1/2]

ts::ReactiveTLSServer::ReactiveTLSServer	(	Reactor &	reactor,
		TCPServer &	socket,
		Object *	owner = `nullptr`
	)

Constructor.

Parameters

[in,out]	reactor	Associated reactor. The reactor object must remain valid as long as this object is valid.
[in,out]	socket	Associated server socket. The socket object must remain valid as long as this object is valid. The ReactiveTLSServer must be initialized before the socket is opened. Important: socket must be an instance of TCPServer, not an instance of TLSServer.
[in]	owner	Optional address of an "owner" object, typically an instance of class containing this object.

◆ ReactiveTLSServer() [2/2]

ts::ReactiveTLSServer::ReactiveTLSServer	(	Reactor &	reactor,
		TCPServer &	socket,
		const TLSArgs &	args,
		Object *	owner = `nullptr`
	)

Constructor with initial arguments.

Parameters

[in,out]	reactor	Associated reactor. The reactor object must remain valid as long as this object is valid.
[in,out]	socket	Associated server socket. The socket object must remain valid as long as this object is valid. The ReactiveTLSServer must be initialized before the socket is opened. Important: socket must be an instance of TCPServer, not an instance of TLSServer.
[in]	args	Initial TLS arguments.
[in]	owner	Optional address of an "owner" object, typically an instance of class containing this object.

Member Function Documentation

◆ startAccept()

bool ts::ReactiveTLSServer::startAccept	(	ReactiveTCPServerHandlerInterface *	handler,
		ReactiveTCPConnection &	client,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

overridevirtual

Start the operation of accepting a TCP client.

Parameters

[in]	handler	Handler class to call when the accept operation completes. The method handleTCPClientAccepted() will be called when the accept() operation completes. If nullptr, no handler is called.
[out]	client	This object receives the new connection. The ReactiveTCPConnection must remain valid as long as the accept operation is in progress and the handler is not called.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error. Success means that the connection was successfully started. The final status of the I/O will be transmitted in the handler.

Reimplemented from ts::ReactiveTCPServer.

◆ handleTCPClientAccepted()

virtual void ts::ReactiveTLSServer::handleTCPClientAccepted	(	ReactiveTCPServer &	server,
		ReactiveTCPConnection &	sock,
		const IPSocketAddress &	addr,
		int	error_code,
		const ObjectPtr &	user_data
	)

overrideprotectedvirtual

Handle the reception of TCP data.

Parameters

[in,out]	server	TCP server socket for which the handler is invoked.
[in,out]	sock	TCP connection socket of the newly accepted client.
[in]	addr	Socket address of the client.
[in]	error_code	System-specific error code, SYS_SUCCESS on success, SYS_EOF if the peer has disconnected, SYS_ERROR in case of unknown error.
[in]	user_data	The user-data shared pointer which was passed to startAccept().

Reimplemented from ts::ReactiveTCPServerHandlerInterface.

◆ socket()

TCPServer & ts::ReactiveTCPServer::socket ( )

inlineinherited

Get a reference to the associated server socket.

Returns: A reference to the associated socket.

◆ isOpen()

bool ts::ReactiveTCPServer::isOpen ( ) const

inlineinherited

Check if the reactive socket is open.

This is different from Socket::isOpen() during the closing phase, after startClose() has been called but before the underlying socket is fully closed.

Returns: True if the reactive socket is open, false if the underlying socket is closed or if startClose() has been called.

◆ cancelAccept()

virtual void ts::ReactiveTCPServer::cancelAccept ( bool silent = false )

virtualinherited

Cancel any pending accept operation on this socket.

Parameters

[in] silent If true, do not report errors through the logger.

◆ startClose()

virtual bool ts::ReactiveTCPServer::startClose	(	ReactiveTCPServerHandlerInterface *	handler,
		bool	silent = `false`,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

virtualinherited

Start closing the socket.

Pending asynchronous operations are canceled. The actual cancelation will take place later. In the meantime, the user's data buffers for these pending operations are busy and shall not be destroyed / deallocated by the application. The close operation terminates when the handler handleTCPClosed() is invoked. At this point, no more operation is pending and the application may get rid of data buffers.

Parameters

[in]	handler	Handler class to call when the close operation completes. The method handleTCPServerClosed~() will be called. If nullptr, no handler is called.
[in]	silent	If true, do not report errors through the logger.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error.

◆ removeFromQueue()

std::shared_ptr< IOSB > ts::ReactiveSocketBase::removeFromQueue	(	IOQueue &	queue,
		IOSB *	iosb
	)

protectedinherited

Search and remove a shared_ptr to IOSB, based on an IOSB address.

Search from the front (end) of the queue since a completed I/O is likely on the front.

Parameters

[in,out]	queue	The queue from which to remove iosb.
[in]	iosb	Standard pointer to an IOSB to search and remove.

Returns: The removed shared_ptr to IOSB, or a null pointer if iosb is not found.

◆ cancelQueue()

template<class REQUEST >
requires std::derived_from<REQUEST, ts::Object>

void ts::ReactiveSocketBase::cancelQueue	(	IOQueue &	inqueue,
		IOQueue &	outqueue
	)

protectedinherited

Transfer all requests from one queue to another and mark all I/O as canceled.

Template Parameters

REQUEST The subclass of Object which is set in react_data of all requests in inqueue.

Parameters

[in,out]	inqueue	The queue from which all requests are removed.
[in,out]	outqueue	The queue which receives all canceled requests.

◆ activateReadReady()

bool ts::ReactiveSocketBase::activateReadReady ( )

protectedinherited

Activate read-ready notification for non-blocking I/O.

Returns: True on success, false on error.

◆ deactivateReadReady()

void ts::ReactiveSocketBase::deactivateReadReady ( bool silent )

protectedinherited

Deactivate read-ready notification for non-blocking I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ activateWriteReady()

bool ts::ReactiveSocketBase::activateWriteReady ( )

protectedinherited

Activate write-ready notification for non-blocking I/O.

Returns: True on success, false on error.

◆ deactivateWriteReady()

void ts::ReactiveSocketBase::deactivateWriteReady ( bool silent )

protectedinherited

Deactivate write-ready notification for non-blocking I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ activateAsynchronousIO()

bool ts::ReactiveSocketBase::activateAsynchronousIO ( )

protectedinherited

Activate notification for asynchronous I/O.

Returns: True on success, false on error.

◆ deactivateAsynchronousIO()

void ts::ReactiveSocketBase::deactivateAsynchronousIO ( bool silent )

protectedinherited

Deactivate notification for asynchronous I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ cancelAsynchronousIO()

void ts::ReactiveSocketBase::cancelAsynchronousIO ( bool silent )

protectedinherited

Cancel all asynchronous I/O in progress.

The cancelation occurs in the background and end of canceled asynchronous I/O will be notified.

Parameters

[in] silent If true, do not report errors through the logger.

◆ cancelAndWaitAsynchronousIO()

bool ts::ReactiveSocketBase::cancelAndWaitAsynchronousIO	(	NonBlockingDevice::IOSB &	iosb,
		bool	silent
	)

protectedinherited

Cancel one specific pending asynchronous I/O and wait for its completion.

Warning: This is a blocking call. It shall be used in case of trouble only.

Parameters

[in,out]	iosb	The asynchronous I/O status block.
[in]	silent	If true, do not report errors through the logger.

Returns: True on success, false on error.

◆ deactivateAll()

void ts::ReactiveSocketBase::deactivateAll ( bool silent )

protectedinherited

Deactivate all registrations for non-blocking and asynchronous I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ reactor()

Reactor & ts::ReactiveBase::reactor ( )

inlineinherited

Get a reference to the associated reactor.

Returns: A reference to the associated reactor.

◆ report()

Report & ts::ReactiveBase::report ( )

inlineinherited

Get a reference to the associated report.

Returns: A reference to the associated report.

◆ signalQueuedOperations()

bool ts::ReactiveBase::signalQueuedOperations ( )

inherited

Trigger the execution of processQueuedOperations() in the context of a Reactor handler.

Create if necessary and then signal a dedicated user event.

Returns: True on success, false on error.

◆ deactivateQueuedOperations()

void ts::ReactiveBase::deactivateQueuedOperations ( bool silent )

inherited

Deactivate the execution of processQueuedOperations() in the context of a Reactor handler.

Deactivate and delete the dedicated user event.

Parameters

[in] silent If true, do not report errors through the logger.

◆ handleUserEvent()

virtual void ts::ReactiveBase::handleUserEvent	(	Reactor &	reactor,
		EventId	id
	)

overrideprotectedvirtualinherited

Handle a user-defined event in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.

Reimplemented from ts::ReactorHandlerInterface.

◆ owner() [1/2]

Object * ts::OwnedObject::owner ( )

inlineinherited

Get the address of the optional "owner" object which was specified in the constructor.

Returns: Address of the "owner" object or a null pointer if there was none.

◆ owner() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

OBJECT * ts::OwnedObject::owner ( )

inherited

Get the address of the "owner" object which was specified in the constructor.

This template version requires that the owner objet is set and of type OBJECT, or some subclass of it. If there is no owner object or if it is not compatible with the template class OBJECT, this is a fatal error and the application is terminated.

Template Parameters

OBJECT A subclass of Object

Returns: Address of the "owner" object or a null pointer if there was none.

◆ isOwned() [1/2]

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned.

Returns: True if this object has an owner, false otherwise.

◆ isOwned() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned by an object of a given type.

Template Parameters

OBJECT A subclass of Object

Returns: True if this object has an owner by an object of type OBJECT, false otherwise.

◆ handleTimer()

virtual void ts::ReactorHandlerInterface::handleTimer	(	Reactor &	reactor,
		EventId	id
	)

virtualinherited

Handle a timer in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the timer which expires.

◆ handleWriteReady()

virtual void ts::ReactorHandlerInterface::handleWriteReady	(	Reactor &	reactor,
		EventId	id,
		int	error_code
	)

virtualinherited

Handle a write-ready event in a Reactor.

This handler is only invoked in the non-blocking I/O model.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.
[in]	error_code	System-specific error code, zero on success, SYS_ERROR in case of unknown error.

◆ setArgs()

void ts::TLSServerBase::setArgs ( const TLSArgs & args )

inlineinherited

Set command line arguments for the server.

Parameters

[in] args TLS arguments.

◆ setCertificatePath()

void ts::TLSServerBase::setCertificatePath ( const UString & path )

inlineinherited

Set the certificate path for the server.

Parameters

[in]

path

Path to the certificate.

On UNIX systems (with OpenSSL), this is the path name of the certificate file in PEM format.
On Windows, this is the name of a certificate, either its "friendly name", its subject name (without "CN="), its DNS name.

◆ getCertificatePath()

const UString & ts::TLSServerBase::getCertificatePath ( ) const

inlineinherited

Get the certificate path for the server.

Returns: A constant reference to the path to the certificate.

See also: setCertificatePath()

◆ setKeyPath()

void ts::TLSServerBase::setKeyPath ( const UString & path )

inlineinherited

Set the private key path for the server.

Parameters

[in]

path

Path to the private key.

On UNIX systems (with OpenSSL), this is the path name of the private key file in PEM format.
On Windows, the private key is retrieved with the certificate and this parameter is unused.

◆ getKeyPath()

const UString & ts::TLSServerBase::getKeyPath ( ) const

inlineinherited

Get the private key path for the server.

Returns: A constant reference to the path to the private key.

See also: setKeyPath()

◆ setCertificateStore()

void ts::TLSServerBase::setCertificateStore ( const UString & name )

inlineinherited

Set the certificate store.

Parameters

[in]

name

On UNIX systems (with OpenSSL), this parameter is unused.
On Windows, the possible values are "system" (Cert:\LocalMachine\My) and "user" (Cert:\CurrentUser\My). The default is "user".

◆ getCertificateStore()

const UString & ts::TLSServerBase::getCertificateStore ( ) const

inlineinherited

Get the certificate store.

Returns: A constant reference to the name of the certificate store.

See also: setCertificateStore()

◆ setEphemeralRSABits()

void ts::TLSServerBase::setEphemeralRSABits ( size_t bits )

inlineinherited

Specify to use an ephemeral self-signed certificate with an ephemeral RSA key of the specified size.

Parameters

[in] bits Size in bits of the ephemeral RSA key. When set to zero, no ephemeral self-signed certificate is used and a persistent certificate must be used.

◆ getEphemeralRSABits()

size_t ts::TLSServerBase::getEphemeralRSABits ( ) const

inlineinherited

Get the size in bits of the ephemeral RSA key which is used for the ephemeral self-signed certificate.

Returns: Size in bits of the ephemeral RSA key. When zero, no ephemeral self-signed certificate is used.

◆ handleTCPServerClosed()

virtual void ts::ReactiveTCPServerHandlerInterface::handleTCPServerClosed	(	ReactiveTCPServer &	server,
		const ObjectPtr &	user_data
	)

virtualinherited

Handle the completion of closing a TCP server socket.

An application closes a ReactiveTCPServer using startClose() and this handler is called when the closing of the socket is complete. This is specifically important on operating systems with asynchronous I/O such as Windows. The application shall not call TCPSocket::close() and immediately consider the socket as done. If there are pending asynchronous I/O, the associated data buffers are still in use, until the cancelation of the these I/O are completed, after closing the socket. The application shall therefore wait for the handleTCPClosed() handler to destroy the data buffers and consider the socket as completely done.

Parameters

[in,out]	server	TCP server socket for which the handler is invoked.
[in]	user_data	The user-data shared pointer which was passed to startClose().

The documentation for this class was generated from the following file:

tsReactiveTLSServer.h

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IOQueue

◆ IOSet

Constructor & Destructor Documentation

◆ ReactiveTLSServer() [1/2]

◆ ReactiveTLSServer() [2/2]

Member Function Documentation

◆ startAccept()

◆ handleTCPClientAccepted()

◆ socket()

◆ isOpen()

◆ cancelAccept()

◆ startClose()

◆ removeFromQueue()

◆ cancelQueue()

◆ activateReadReady()

◆ deactivateReadReady()

◆ activateWriteReady()

◆ deactivateWriteReady()

◆ activateAsynchronousIO()

◆ deactivateAsynchronousIO()

◆ cancelAsynchronousIO()

◆ cancelAndWaitAsynchronousIO()

◆ deactivateAll()

◆ reactor()

◆ report()

◆ signalQueuedOperations()

◆ deactivateQueuedOperations()

◆ handleUserEvent()

◆ owner() [1/2]

◆ owner() [2/2]

◆ isOwned() [1/2]

◆ isOwned() [2/2]

◆ handleTimer()

◆ handleWriteReady()

◆ setArgs()

◆ setCertificatePath()

◆ getCertificatePath()

◆ setKeyPath()

◆ getKeyPath()

◆ setCertificateStore()

◆ getCertificateStore()

◆ setEphemeralRSABits()

◆ getEphemeralRSABits()

◆ handleTCPServerClosed()