![]() |
TSDuck v3.45-4733
MPEG Transport Stream Toolkit
|
SSL/TLS server socket for use in a Reactor environment. More...
#include <tsReactiveTLSServer.h>


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. | |
| 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. | |
| bool | muteReport (bool mute) |
| Temporarily mute the associated report. | |
| 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 () const |
| Access the Report which is associated with this object. | |
| 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. | |
| Report * | setReport (Report *report) |
| Associate this object with another Report to log errors. | |
| ReporterBase * | setReport (ReporterBase *delegate) |
| Associate this object with another ReporterBase to log errors. | |
| 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. | |
Static Public Member Functions | |
| static int | SilentLevel (bool silent) |
| Compute a log severity level from a "silent" parameter. | |
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. | |
| bool | createSignalQueuedOperations () |
| Create, if necessary, the dedicated user event for signalQueuedOperations(). | |
| 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 | deactivateQueuedOperations (bool silent) |
| Deactivate the execution of processQueuedOperations() in the context of a Reactor handler. | |
| 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 | handleBroadcastEvent (Reactor &reactor, int error_code, const ObjectPtr &user_data) |
| Handle a broadcast event in a Reactor. | |
| 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. | |
| bool | uncheckedSignalQueuedOperations () |
| Trigger the execution of processQueuedOperations() from another thread. | |
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.
|
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.
|
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.
| ts::ReactiveTLSServer::ReactiveTLSServer | ( | Reactor & | reactor, |
| TCPServer & | socket, | ||
| Object * | owner = nullptr |
||
| ) |
Constructor.
| [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. |
| ts::ReactiveTLSServer::ReactiveTLSServer | ( | Reactor & | reactor, |
| TCPServer & | socket, | ||
| const TLSArgs & | args, | ||
| Object * | owner = nullptr |
||
| ) |
Constructor with initial arguments.
| [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. |
|
overridevirtual |
Start the operation of accepting a TCP client.
| [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. |
Reimplemented from ts::ReactiveTCPServer.
|
overrideprotectedvirtual |
Handle the reception of TCP data.
| [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.
|
inlineinherited |
Get a reference to the associated server socket.
|
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.
|
virtualinherited |
Cancel any pending accept operation on this socket.
| [in] | silent | If true, do not report errors through the logger. |
|
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.
| [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. |
|
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.
| [in,out] | queue | The queue from which to remove iosb. |
| [in] | iosb | Standard pointer to an IOSB to search and remove. |
|
protectedinherited |
Transfer all requests from one queue to another and mark all I/O as canceled.
| REQUEST | The subclass of Object which is set in react_data of all requests in inqueue. |
| [in,out] | inqueue | The queue from which all requests are removed. |
| [in,out] | outqueue | The queue which receives all canceled requests. |
|
protectedinherited |
Activate read-ready notification for non-blocking I/O.
|
protectedinherited |
Deactivate read-ready notification for non-blocking I/O.
| [in] | silent | If true, do not report errors through the logger. |
|
protectedinherited |
Activate write-ready notification for non-blocking I/O.
|
protectedinherited |
Deactivate write-ready notification for non-blocking I/O.
| [in] | silent | If true, do not report errors through the logger. |
|
protectedinherited |
Activate notification for asynchronous I/O.
|
protectedinherited |
Deactivate notification for asynchronous I/O.
| [in] | silent | If true, do not report errors through the logger. |
|
protectedinherited |
Cancel all asynchronous I/O in progress.
The cancelation occurs in the background and end of canceled asynchronous I/O will be notified.
| [in] | silent | If true, do not report errors through the logger. |
|
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.
| [in,out] | iosb | The asynchronous I/O status block. |
| [in] | silent | If true, do not report errors through the logger. |
|
protectedinherited |
Deactivate all registrations for non-blocking and asynchronous I/O.
| [in] | silent | If true, do not report errors through the logger. |
|
inlineinherited |
Get a reference to the associated reactor.
|
inherited |
Trigger the execution of processQueuedOperations() in the context of a Reactor handler.
Create if necessary and then signal a dedicated user event.
|
protectedinherited |
Deactivate the execution of processQueuedOperations() in the context of a Reactor handler.
Deactivate and delete the dedicated user event.
| [in] | silent | If true, do not report errors through the logger. |
|
protectedinherited |
Create, if necessary, the dedicated user event for signalQueuedOperations().
Useless if signalQueuedOperations() is used. Only required with use of uncheckedSignalQueuedOperations().
|
protectedinherited |
Trigger the execution of processQueuedOperations() from another thread.
The event must have been previously created, either using createSignalQueuedOperations() or signalQueuedOperations().
|
overrideprotectedvirtualinherited |
Handle a user-defined event in a Reactor.
| [in,out] | reactor | Reactor into which the handler is invoked. |
| [in] | id | Id of the event which was signaled. |
Reimplemented from ts::ReactorHandlerInterface.
|
inherited |
Associate this object with another Report to log errors.
| [in] | report | Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded. |
|
inherited |
Associate this object with another ReporterBase to log errors.
| [in] | delegate | Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used.. |
|
inherited |
Temporarily mute the associated report.
| [in] | mute | It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false. |
|
inlinestaticinherited |
Compute a log severity level from a "silent" parameter.
Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.
| [in] | silent | If true, do not report errors, report debug messages instead. |
|
inlineinherited |
Get the address of the optional "owner" object which was specified in the constructor.
|
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.
| OBJECT | A subclass of Object |
|
inlineinherited |
Check if the object is owned.
|
inlineinherited |
Check if the object is owned by an object of a given type.
| OBJECT | A subclass of Object |
|
virtualinherited |
Handle a broadcast event in a Reactor.
A broadcast event is sent to all currently registered events in the reactor.
| [in,out] | reactor | Reactor into which the handler is invoked. |
| [in] | error_code | Application-specific error code which was passed to Reactor::signalBroadcastEvent(). |
| [in] | user_data | The user-data shared pointer which was passed to Reactor::signalBroadcastEvent(). |
|
virtualinherited |
Handle a write-ready event in a Reactor.
This handler is only invoked in the non-blocking I/O model.
| [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. |
Reimplemented in ts::ReactiveTCPConnection.
|
inlineinherited |
Set command line arguments for the server.
| [in] | args | TLS arguments. |
|
inlineinherited |
Set the certificate path for the server.
| [in] | path | Path to the certificate.
|
|
inlineinherited |
Get the certificate path for the server.
|
inlineinherited |
Set the private key path for the server.
| [in] | path | Path to the private key.
|
|
inlineinherited |
Get the private key path for the server.
|
inlineinherited |
Set the certificate store.
| [in] | name |
|
|
inlineinherited |
Get the certificate store.
|
inlineinherited |
Specify to use an ephemeral self-signed certificate with an ephemeral RSA key of the specified size.
| [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. |
|
inlineinherited |
Get the size in bits of the ephemeral RSA key which is used for the ephemeral self-signed certificate.
|
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.
| [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(). |