Virtual base class for reactive classes in a Reactor environment.
More...
#include <tsReactiveBase.h>
|
| static int | SilentLevel (bool silent) |
| | Compute a log severity level from a "silent" parameter.
|
| |
Virtual base class for reactive classes in a Reactor environment.
◆ ReactiveBase()
| ts::ReactiveBase::ReactiveBase |
( |
Reactor & |
reactor, |
|
|
Object * |
owner = nullptr |
|
) |
| |
Constructor.
- Parameters
-
| [in,out] | reactor | Associated reactor. The reactor object must remain valid as long as this object is valid. |
| [in] | owner | Optional address of an "owner" object, typically an instance of class containing this object. |
◆ reactor()
| Reactor & ts::ReactiveBase::reactor |
( |
| ) |
|
|
inline |
Get a reference to the associated reactor.
- Returns
- A reference to the associated reactor.
◆ signalQueuedOperations()
| bool ts::ReactiveBase::signalQueuedOperations |
( |
| ) |
|
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 | ) |
|
|
protected |
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. |
◆ processQueuedOperations()
| virtual void ts::ReactiveBase::processQueuedOperations |
( |
| ) |
|
|
protectedvirtual |
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 in ts::ReactiveTCPConnection, and ts::ReactiveTLSConnection.
◆ handleUserEvent()
| virtual void ts::ReactiveBase::handleUserEvent |
( |
Reactor & |
reactor, |
|
|
EventId |
id |
|
) |
| |
|
overrideprotectedvirtual |
◆ 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. |
◆ handleReadReady()
| virtual void ts::ReactorHandlerInterface::handleReadReady |
( |
Reactor & |
reactor, |
|
|
EventId |
id, |
|
|
int |
error_code |
|
) |
| |
|
virtualinherited |
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 in ts::ReactiveTCPConnection.
◆ 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. |
Reimplemented in ts::ReactiveTCPConnection.
◆ handleAsynchronousIO()
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 in ts::ReactiveTCPConnection.
The documentation for this class was generated from the following file:
1.9.8