Perform a simple Web request (HTTP, HTTPS, FTP) 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)
	Constructor.

virtual	~ReactiveWebRequest () override
	Destructor.

bool	abort (bool silent=false)
	Abort the operation of receiving data from the web request.

WebRequestArgs &	args ()
	Access the Web request arguments to get or set them.

const WebRequestArgs &	args () const
	Access the Web request arguments to get them.

bool	isOpen () const
	Check if the transfer is in progress.

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.

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	start (ReactiveWebHandlerInterface *handler, const UString &url, size_t buffer_size=Device::DEFAULT_RECEIVE_BUFFER_SIZE, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of opening an URL and receiving its content.

const WebRequestStatus &	status () const
	Access the Web request status.

Static Public Member Functions
static UString	GetLibraryVersion ()
	Get the version of the underlying HTTP library.

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

Protected Member Functions
bool	createSignalQueuedOperations ()
	Create, if necessary, the dedicated user event for signalQueuedOperations().

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

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.

bool	uncheckedSignalQueuedOperations ()
	Trigger the execution of processQueuedOperations() from another thread.

Detailed Description

Perform a simple Web request (HTTP, HTTPS, FTP) in a Reactor environment.

On UNIX systems, the implementation uses libcurl. On Windows systems, the implementation uses Microsoft WinInet.

The proxy and transfer settings must be set before starting any download operation. The HTTP status and the response headers are available after a successful download start.

By default, no proxy is used. If no proxy is set, the default proxy is used (system configuration on Windows, http_proxy environment on Unix systems).

Constructor & Destructor Documentation

◆ ReactiveWebRequest()

ts::ReactiveWebRequest::ReactiveWebRequest ( Reactor & reactor )

explicit

Constructor.

Parameters

[in,out] reactor Associated reactor. The reactor object must remain valid as long as this object is valid.

Member Function Documentation

◆ args() [1/2]

WebRequestArgs & ts::ReactiveWebRequest::args ( )

inline

Access the Web request arguments to get or set them.

All Web request arguments must be set before opening a URL.

Returns: A non-const reference to the Web request arguments.

◆ args() [2/2]

const WebRequestArgs & ts::ReactiveWebRequest::args ( ) const

inline

Access the Web request arguments to get them.

Returns: A const reference to the Web request arguments.

◆ status()

const WebRequestStatus & ts::ReactiveWebRequest::status ( ) const

inline

Access the Web request status.

The request status is available in handleWebOpen() callback and later. The WebRequestStatus::contentSize() is updated during the transfer.

Returns: A const reference to the Web request status.

◆ start()

bool ts::ReactiveWebRequest::start	(	ReactiveWebHandlerInterface *	handler,
		const UString &	url,
		size_t	buffer_size = `Device::DEFAULT_RECEIVE_BUFFER_SIZE`,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start the operation of opening an URL and receiving its content.

Parameters

[in]	handler	Handler class to call when the final URL (after all redirections) is open and when a chunk of data is available. The transfer is complete when the handler methods handleWebOpen() or handleWebReceive() report an error. The transfer is considered successful when handleWebReceive() receives the error SYS_EOF.
[in]	url	The complete URL to fetch.
[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.

◆ isOpen()

bool ts::ReactiveWebRequest::isOpen ( ) const

Check if the transfer is in progress.

Returns: True if the transfer is in progress.

◆ abort()

bool ts::ReactiveWebRequest::abort ( bool silent = false )

Abort the operation of receiving data from the web request.

If the transfer is in progress, the handler methods handleWebOpen() or handleWebReceive() report the error SYS_CANCELED.

Parameters

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

Returns: True on success, false on error.

◆ GetLibraryVersion()

static UString ts::ReactiveWebRequest::GetLibraryVersion ( )

static

Get the version of the underlying HTTP library.

Returns: The library version.

◆ 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 Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReactiveWebRequest()

Member Function Documentation

◆ args() [1/2]

◆ args() [2/2]

◆ status()

◆ start()

◆ isOpen()

◆ abort()

◆ GetLibraryVersion()

◆ reactor()

◆ signalQueuedOperations()

◆ deactivateQueuedOperations()

◆ createSignalQueuedOperations()

◆ uncheckedSignalQueuedOperations()

◆ processQueuedOperations()

◆ handleUserEvent()

◆ report()

◆ setReport() [1/2]

◆ setReport() [2/2]

◆ muteReport()

◆ SilentLevel()

◆ handleTimer()

◆ handleBroadcastEvent()

◆ handleProcessTermination()

◆ handleReadReady()

◆ handleWriteReady()

◆ handleAsynchronousIO()