Web request for use in a Reactor environment. More...

#include <tsReactiveWebRequest.h>

Inheritance diagram for ts::ReactiveWebRequest:

[legend]

Collaboration diagram for ts::ReactiveWebRequest:

[legend]

Public Member Functions
	ReactiveWebRequest (Reactor &reactor, WebRequest &request)
	Constructor.

virtual	~ReactiveWebRequest () override
	Destructor.

Device &	device ()
	Get a reference to the associated non-blocking device.

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

bool	muteReport (bool mute)
	Temporarily mute the associated report.

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

virtual Report &	report () const override
	Access the Report which is associated with this object.

WebRequest &	request ()
	Get a reference to the associated web request.

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.

bool	startClose (ReactiveWebHandlerInterface *handler, bool silent=false, const ObjectPtr &user_data=ObjectPtr())
	Start closing the web request.

bool	startOpen (ReactiveWebHandlerInterface *handler, const UString &url, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of opening an URL.

bool	startReceive (ReactiveWebHandlerInterface handler, void buffer, size_t max_size, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of receiving data from the web request.

Static Public Member Functions
static int	SilentLevel (bool silent, int default_severity=Severity::Error)
	Compute a log severity level from a "silent" parameter.

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

using	IOSB = Device::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 immediate I/O.

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

bool	cancelAndWaitAsynchronousIO (Device::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 immediate 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 immediate I/O.

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

virtual void	handleAsynchronousIO (Reactor &reactor, EventId id, Device::IOSB &iosb, size_t io_size)
	Handle an asynchronous I/O completion event in a Reactor.

virtual void	handleBroadcastEvent (Reactor &reactor, int error_code, const ObjectPtr &user_data)
	Handle a broadcast event in a Reactor.

virtual void	handleProcessTermination (Reactor &reactor, EventId id, int pid)
	Handle a process termination event in a Reactor.

virtual void	handleReadReady (Reactor &reactor, EventId id, int error_code)
	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 &reactor, EventId id, int error_code)
	Handle a write-ready event in a Reactor.

virtual void	processQueuedOperations ()
	This virtual method processes operations in the context of a Reactor handler.

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.

Detailed Description

Web request for use in a Reactor environment.

The class ReactiveWebRequest is a wrapper around WebRequest to handle reactive I/O.

The actual WebRequest is a separate object. It is initialized and configured by the application. The application shall not directly call open(), receive(), or close() on this WebRequest and delegate these operations to startOpen(), startReceive(), and startClose() in class ReactiveWebRequest.

Member Typedef Documentation

◆ IOQueue

using ts::ReactiveDevice::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 immediate 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::ReactiveDevice::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

◆ ReactiveWebRequest()

ts::ReactiveWebRequest::ReactiveWebRequest	(	Reactor &	reactor,
		WebRequest &	request
	)

Constructor.

Parameters

[in,out]	reactor	Associated reactor. The reactor object must remain valid as long as this object is valid.
[in,out]	request	Associated Web request. The request object must remain valid as long as this object is valid. The ReactiveWebRequest must be initialized before the request is opened.

Member Function Documentation

◆ request()

WebRequest & ts::ReactiveWebRequest::request ( )

inline

Get a reference to the associated web request.

Returns: A reference to the associated web request.

◆ isOpen()

bool ts::ReactiveWebRequest::isOpen ( ) const

inline

Check if the reactive web request is open.

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

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

◆ startOpen()

bool ts::ReactiveWebRequest::startOpen	(	ReactiveWebHandlerInterface *	handler,
		const UString &	url,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start the operation of opening an URL.

Parameters

[in]	handler	Handler class to call when the operation completes. The method handleWebOpen() will be called. If nullptr, no handler is called.
[in]	url	The complete URL to fetch.
[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.

◆ startReceive()

bool ts::ReactiveWebRequest::startReceive	(	ReactiveWebHandlerInterface *	handler,
		void *	buffer,
		size_t	max_size,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start the operation of receiving data from the web request.

Parameters

[in]	handler	Handler class to call when data are received. The method handleWebReceive() will be called.
[out]	buffer	Address of the buffer for the received data.
[in]	max_size	Size in bytes of the reception buffer.
[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.

◆ startClose()

bool ts::ReactiveWebRequest::startClose	(	ReactiveWebHandlerInterface *	handler,
		bool	silent = `false`,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start closing the web request.

Parameters

[in]	handler	Handler class to call when the close operation completes. The method handleWebClosed() 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.

◆ device()

Device & ts::ReactiveDevice::device ( )

inlineinherited

Get a reference to the associated non-blocking device.

Returns: A reference to the associated non-blocking device.

◆ removeFromQueue()

std::shared_ptr< IOSB > ts::ReactiveDevice::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::ReactiveDevice::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::ReactiveDevice::activateReadReady ( )

protectedinherited

Activate read-ready notification for immediate I/O.

Returns: True on success, false on error.

◆ deactivateReadReady()

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

protectedinherited

Deactivate read-ready notification for immediate I/O.

Parameters

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

◆ activateWriteReady()

bool ts::ReactiveDevice::activateWriteReady ( )

protectedinherited

Activate write-ready notification for immediate I/O.

Returns: True on success, false on error.

◆ deactivateWriteReady()

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

protectedinherited

Deactivate write-ready notification for immediate I/O.

Parameters

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

◆ activateAsynchronousIO()

bool ts::ReactiveDevice::activateAsynchronousIO ( )

protectedinherited

Activate notification for asynchronous I/O.

Returns: True on success, false on error.

◆ deactivateAsynchronousIO()

void ts::ReactiveDevice::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::ReactiveDevice::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::ReactiveDevice::cancelAndWaitAsynchronousIO	(	Device::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::ReactiveDevice::deactivateAll ( bool silent )

protectedinherited

Deactivate all registrations for immediate 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.

◆ createSignalQueuedOperations()

bool ts::ReactiveBase::createSignalQueuedOperations ( )

protectedinherited

Create, if necessary, the dedicated user event for signalQueuedOperations().

Useless if signalQueuedOperations() is used. Only required with use of uncheckedSignalQueuedOperations().

Returns: True on success, false on error.

◆ uncheckedSignalQueuedOperations()

bool ts::ReactiveBase::uncheckedSignalQueuedOperations ( )

protectedinherited

Trigger the execution of processQueuedOperations() from another thread.

The event must have been previously created, either using createSignalQueuedOperations() or signalQueuedOperations().

Returns: True on success, false on error.

◆ processQueuedOperations()

virtual void ts::ReactiveBase::processQueuedOperations ( )

protectedvirtualinherited

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::ReactiveMessageQueue< MSG >, ts::ReactiveStream, ts::ReactiveTCPConnection, ts::ReactiveTLSConnection, and ts::ReactiveWorkerPool.

◆ 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.

◆ report()

virtual Report & ts::ReporterBase::report ( ) const

overridevirtualinherited

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.

Implements ts::ReporterInterface.

◆ setReport() [1/2]

Report * ts::ReporterBase::setReport ( Report * report )

inherited

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]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase * delegate )

inherited

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,
		int	default_severity = `Severity::Error`
	)

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.
[in]	default_severity	Default severity, in non-silent mode (error by default).

Returns: Error when silent is false, Debug 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.

◆ handleBroadcastEvent()

virtual void ts::ReactorHandlerInterface::handleBroadcastEvent	(	Reactor &	reactor,
		int	error_code,
		const ObjectPtr &	user_data
	)

virtualinherited

Handle a broadcast event in a Reactor.

A broadcast event is sent to all currently registered events in the reactor.

Parameters

[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().

◆ handleProcessTermination()

virtual void ts::ReactorHandlerInterface::handleProcessTermination	(	Reactor &	reactor,
		EventId	id,
		int	pid
	)

virtualinherited

Handle a process termination event in a Reactor.

This handler is invoked when the process is no longer there. It is possible that the process was already terminated for a while. It is even possible that the process never really started. There is no portable way to get the process termination status.

Parameters

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

◆ 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 immediate 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::ReactiveStream.

◆ 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 immediate 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::ReactiveStream, and ts::ReactiveTCPConnection.

◆ handleAsynchronousIO()

virtual void ts::ReactorHandlerInterface::handleAsynchronousIO	(	Reactor &	reactor,
		EventId	id,
		Device::IOSB &	iosb,
		size_t	io_size
	)

virtualinherited

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::ReactiveStream, and ts::ReactiveTCPConnection.

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

tsReactiveWebRequest.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IOQueue

◆ IOSet

Constructor & Destructor Documentation

◆ ReactiveWebRequest()

Member Function Documentation

◆ request()

◆ isOpen()

◆ startOpen()

◆ startReceive()

◆ startClose()

◆ device()

◆ removeFromQueue()

◆ cancelQueue()

◆ activateReadReady()

◆ deactivateReadReady()

◆ activateWriteReady()

◆ deactivateWriteReady()

◆ activateAsynchronousIO()

◆ deactivateAsynchronousIO()

◆ cancelAsynchronousIO()

◆ cancelAndWaitAsynchronousIO()

◆ deactivateAll()

◆ reactor()

◆ signalQueuedOperations()

◆ deactivateQueuedOperations()

◆ createSignalQueuedOperations()

◆ uncheckedSignalQueuedOperations()

◆ processQueuedOperations()

◆ handleUserEvent()

◆ report()

◆ setReport() [1/2]

◆ setReport() [2/2]

◆ muteReport()

◆ SilentLevel()

◆ handleTimer()

◆ handleBroadcastEvent()

◆ handleProcessTermination()

◆ handleReadReady()

◆ handleWriteReady()

◆ handleAsynchronousIO()