TCP connected socket for use in a Reactor environment.
More...
#include <tsReactiveTCPConnection.h>
|
| | ReactiveTCPConnection (Reactor &reactor, TCPConnection &socket, Object *owner=nullptr) |
| | Constructor.
|
| |
|
virtual | ~ReactiveTCPConnection () override |
| | Destructor.
|
| |
| virtual void | cancelSendReceive (bool silent=false) |
| | Cancel any pending send or receive operation on this socket.
|
| |
| 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.
|
| |
| 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.
|
| |
| TCPConnection & | socket () |
| | Get a reference to the associated socket.
|
| |
| virtual bool | startClose (ReactiveTCPConnectionHandlerInterface *handler, bool silent=false, const ObjectPtr &user_data=ObjectPtr()) |
| | Start closing the socket.
|
| |
| virtual bool | startCloseWriter (ReactiveTCPConnectionHandlerInterface *handler, bool silent=false, const ObjectPtr &user_data=ObjectPtr()) |
| | Start closing the send direction of the socket.
|
| |
| virtual bool | startConnect (ReactiveTCPConnectionHandlerInterface *handler, const IPSocketAddress &addr, const ObjectPtr &user_data=ObjectPtr()) |
| | Start the operation of connecting to a TCP server.
|
| |
| virtual bool | startReceive (ReactiveTCPConnectionHandlerInterface *handler, size_t buffer_size=DEFAULT_RECEIVE_BUFFER_SIZE, const ObjectPtr &user_data=ObjectPtr()) |
| | Start the operation of receiving messages from the socket.
|
| |
| virtual bool | startSend (ReactiveTCPConnectionHandlerInterface *handler, const void *data, size_t size, const ObjectPtr &user_data=ObjectPtr()) |
| | Start the operation of sending data over the TCP connection.
|
| |
| virtual void | whenAccepted (ReactiveTCPConnectionHandlerInterface *handler, const ObjectPtr &user_data=ObjectPtr()) |
| | Define the handler to call when accepted as a client session by a TCP server.
|
| |
|
| static int | SilentLevel (bool silent) |
| | Compute a log severity level from a "silent" parameter.
|
| |
|
| 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 | 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 | handleAsynchronousIO (Reactor &, EventId, IOSB &, size_t) override |
| | Handle an asynchronous I/O completion event in a Reactor.
|
| |
| virtual void | handleReadReady (Reactor &, EventId, int) override |
| | Handle a read-ready event in a Reactor.
|
| |
| 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 &, EventId, int) override |
| | Handle a write-ready event in a Reactor.
|
| |
| virtual void | processQueuedOperations () override |
| | This virtual method processes operations in the context of a Reactor handler.
|
| |
| void | processReceiveBuffer (ByteBlock &data, ReactiveTCPInputControl &control, HandlerType *handler, int error_code, const ObjectPtr &user_data) |
| | Invoke the receive handler as many times as possible on a data buffer.
|
| |
| std::shared_ptr< IOSB > | removeFromQueue (IOQueue &queue, IOSB *iosb) |
| | Search and remove a shared_ptr to IOSB, based on an IOSB address.
|
| |
TCP connected socket for use in a Reactor environment.
The class ReactiveTCPConnection is a wrapper around TCPConnection to handle reactive I/O.
The actual socket is a separate object. It is initialized and configured by the application. The application shall not directly call connect(), send(), receive(), closeWriter(), or close() on this socket and delegate these operations to startConnect(), startSend(), startReceive(), startCloseWriter() and startClose() in class ReactiveTCPConnection.
◆ IOQueue
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
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.
◆ ReactiveTCPConnection()
Constructor.
- Parameters
-
| [in,out] | reactor | Associated reactor. The reactor object must remain valid as long as this object is valid. |
| [in,out] | socket | Associated socket. The socket object must remain valid as long as this object is valid. The ReactiveTCPConnection must be initialized before the socket is opened. |
| [in] | owner | Optional address of an "owner" object, typically an instance of class containing this object. |
◆ socket()
Get a reference to the associated socket.
- Returns
- A reference to the associated socket.
◆ isOpen()
| bool ts::ReactiveTCPConnection::isOpen |
( |
| ) |
const |
|
inline |
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.
◆ startConnect()
Start the operation of connecting to a TCP server.
- Parameters
-
| [in] | handler | Handler class to call when the connect operation completes. The method handleTCPConnected() will be called. If nullptr, no handler is called. |
| [in] | addr | IP address and port of the server to connect to. |
| [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 in ts::ReactiveTLSConnection.
◆ whenAccepted()
Define the handler to call when accepted as a client session by a TCP server.
Typically called from the constructor of an enclosing object which is used as client session context.
- Parameters
-
| [in] | handler | Handler class to call when this object is connected to a remote client by a server. The method handleTCPAccepted() will be called. If nullptr, no handler is called. |
| [in] | user_data | A shared pointer which will be passed unmodified to handler. |
Reimplemented in ts::ReactiveTLSConnection.
◆ startSend()
Start the operation of sending data over the TCP connection.
- Parameters
-
| [in] | handler | Handler class to call when the send operation completes. The method handleTCPSend() will be called. If nullptr, no handler is called. |
| [in] | data | Address of the data to send. The corresponding memory area must remain valid until the completion or cancelation of the send operation. |
| [in] | size | Size in bytes of the data to send. |
| [in] | user_data | A shared pointer which will be passed unmodified to handler. |
- Returns
- True on success, false on error. Success means that the I/O was successfully started. The final status of the I/O will be transmitted in the handler.
Reimplemented in ts::ReactiveTLSConnection.
◆ startCloseWriter()
Start closing the send direction of the socket.
The peer will receive an end-of-file condition. All pending send operations are guaranteed to complete before that end-of-file is sent.
- Parameters
-
| [in] | handler | Handler class to call when the close-writer operation completes. The method handleTCPSend() will be called with its parameter error_code containing SYS_EOF. 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.
Reimplemented in ts::ReactiveTLSConnection.
◆ startReceive()
Start the operation of receiving messages from the socket.
- Parameters
-
| [in] | handler | Handler class to call each time data are received. The method handleTCPReceive() will be called for each new message. Cannot be null. If a previous receive handler was registered, it is replaced. |
| [in] | buffer_size | Size of input buffers to receive data. |
| [in] | user_data | A shared pointer which will be passed unmodified to handler. |
- Returns
- True on success, false on error. Success means that the I/O was successfully started. The final status of the I/O will be transmitted in the handler.
Reimplemented in ts::ReactiveTLSConnection.
◆ cancelSendReceive()
| virtual void ts::ReactiveTCPConnection::cancelSendReceive |
( |
bool |
silent = false | ) |
|
|
virtual |
Cancel any pending send or receive operation on this socket.
If a repeated reception operation is in progress, the repetition is canceled as well.
- Parameters
-
| [in] | silent | If true, do not report errors through the logger. |
Reimplemented in ts::ReactiveTLSConnection.
◆ startClose()
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.
Note that the application, usually inside a handler, can call disconnect() on the TCPConnection object. Only closeWriter() and close() shall not be called and replaced by startCloseWriter() and startClose() on the ReactiveTCPConnection object.
- Parameters
-
| [in] | handler | Handler class to call when the close operation completes. The method handleTCPClosed() 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.
Reimplemented in ts::ReactiveTLSConnection.
◆ processReceiveBuffer()
Invoke the receive handler as many times as possible on a data buffer.
- Parameters
-
| [in,out] | data | Data buffer containing the received data. On output, data which are processed by the handler are removed. |
| [in,out] | control | Input control. On input, this is the previously returned value from the handler. Modified by the handler. |
| [in] | handler | Application handler. |
| [in] | error_code | Receive error code. If not success, the handler is called exactly once. |
| [in] | user_data | User data for the handler. |
◆ processQueuedOperations()
| virtual void ts::ReactiveTCPConnection::processQueuedOperations |
( |
| ) |
|
|
overrideprotectedvirtual |
This virtual method processes operations in the context of a Reactor handler.
This is dedicated to operations which must be serialized from an application perspective. These operations are typically queued when triggered from a method which is called by the application. When the reactor processes events, we are sure that the application is not executing a handler. The default implementation does nothing. A subclass should override it if it calls signalQueuedOperations().
Reimplemented from ts::ReactiveBase.
Reimplemented in ts::ReactiveTLSConnection.
◆ handleReadReady()
| virtual void ts::ReactiveTCPConnection::handleReadReady |
( |
Reactor & |
reactor, |
|
|
EventId |
id, |
|
|
int |
error_code |
|
) |
| |
|
overrideprotectedvirtual |
Handle a read-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. |
Reimplemented from ts::ReactorHandlerInterface.
◆ handleWriteReady()
| virtual void ts::ReactiveTCPConnection::handleWriteReady |
( |
Reactor & |
reactor, |
|
|
EventId |
id, |
|
|
int |
error_code |
|
) |
| |
|
overrideprotectedvirtual |
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. |
Reimplemented from ts::ReactorHandlerInterface.
◆ handleAsynchronousIO()
| virtual void ts::ReactiveTCPConnection::handleAsynchronousIO |
( |
Reactor & |
reactor, |
|
|
EventId |
id, |
|
|
IOSB & |
iosb, |
|
|
size_t |
io_size |
|
) |
| |
|
overrideprotectedvirtual |
Handle an asynchronous I/O completion event in a Reactor.
This handler is only invoked in the asynchronous I/O model.
- Parameters
-
| [in,out] | reactor | Reactor into which the handler is invoked. |
| [in] | id | Id of the event which was signaled. |
| [in,out] | iosb | IOSB structure which was used when the asynchronous I/O was started. A system-specific error code is in iosb, SYS_CANCELED if the I/O was canceled before completion. |
| [in] | io_size | Size of the I/O in bytes. |
Reimplemented from ts::ReactorHandlerInterface.
◆ 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()
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.
◆ 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 | ) |
|
|
protectedinherited |
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 |
◆ report()
| Report & ts::ReporterBase::report |
( |
| ) |
const |
|
inherited |
Access the Report which is associated with this object.
Can be called from another thread only if the Report object is thread-safe.
- Returns
- A reference to the associated report.
◆ setReport() [1/2]
Associate this object with another Report to log errors.
- Parameters
-
| [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. |
- Returns
- The address of the previous Report object or a null pointer if there was none.
◆ setReport() [2/2]
Associate this object with another ReporterBase to log errors.
- Parameters
-
| [in] | delegate | Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used.. |
- Returns
- The address of the previous ReporterBase object or a null pointer if there was none.
◆ muteReport()
| bool ts::ReporterBase::muteReport |
( |
bool |
mute | ) |
|
|
inherited |
Temporarily mute the associated report.
- Parameters
-
| [in] | mute | It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false. |
- Returns
- Previous state of the mute field.
◆ SilentLevel()
| static int ts::ReporterBase::SilentLevel |
( |
bool |
silent | ) |
|
|
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.
- Parameters
-
| [in] | silent | If true, do not report errors, report debug messages instead. |
- Returns
- Error when silent is false, Debug otherwise.
◆ 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
-
- 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
-
- 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. |
◆ DEFAULT_RECEIVE_BUFFER_SIZE
| constexpr size_t ts::ReactiveTCPConnection::DEFAULT_RECEIVE_BUFFER_SIZE = 4096 |
|
staticconstexpr |
The documentation for this class was generated from the following file: