ts::RestClient Class Reference

Basic helper for REST API clients. More...

#include <tsRestClient.h>

Inheritance diagram for ts::RestClient:

Collaboration diagram for ts::RestClient:

Public Member Functions
	RestClient (const RestArgs &args)
	Constructor.
	RestClient (Report *report, const RestArgs &args)
	Constructor.
	RestClient (ReporterBase *delegate, const RestArgs &args)
	Constructor.
virtual	~RestClient () override
	Destructor.
bool	call (const UString &api, const UString &post_data=UString())
	Call a REST API.
bool	getResponseJSON (json::ValuePtr &value) const
	Get the response in JSON form.
void	getResponseText (UString &response) const
	Get the response in text form (interpreted from UTF-8).
int	httpStatus () const
	Get the HTTP status code (200, 404, etc).
UString	mimeType (bool simple=true, bool lowercase=true) const
	Get the MIME type in the response headers.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
Report &	report () const
	Access the Report which is associated with this object.
const ByteBlock &	response () const
	Get the response in binary format.
const UStringToUStringMultiMap &	responseHeaders () const
	Get all response headers.
void	setAcceptTypes (const UString &types)
	Set the accepted MIME types for the response.
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.

Static Public Member Functions
static int	SilentLevel (bool silent)
	Compute a log severity level from a "silent" parameter.

Detailed Description

Basic helper for REST API clients.

Constructor & Destructor Documentation

RestClient() [1/3]

ts::RestClient::RestClient

(

const RestArgs &

args

)

Constructor.

Parameters

[in]

args

Initial REST operation arguments. This instance will keep a copy of it.

RestClient() [2/3]

ts::RestClient::RestClient	(	Report *	report,
		const RestArgs &	args
	)

Constructor.

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.
[in]	args	Initial REST operation arguments. This instance will keep a copy of it.

RestClient() [3/3]

ts::RestClient::RestClient	(	ReporterBase *	delegate,
		const RestArgs &	args
	)

Constructor.

Parameters

[in]	delegate	Use the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]	args	Initial REST operation arguments. This instance will keep a copy of it.

Member Function Documentation

setAcceptTypes()

void ts::RestClient::setAcceptTypes ( const UString &  types )

inline

Set the accepted MIME types for the response.

Parameters

[in]

types

Accepted MIME type or comma-separated types. Typical values are u"*‍/*", u"text/plain", u"application/json", u"application/xml".

call()

bool ts::RestClient::call	(	const UString &	api,
		const UString &	post_data = UString()
	)

Call a REST API.

Parameters

[in]	api	Path of the API call. Concatenated with the RestArgs::api_root it is not empty.
[in]	post_data	If not empty, the request is a POST with these data.

Returns

True on success, false on error.

httpStatus()

int ts::RestClient::httpStatus ( ) const

inline

Get the HTTP status code (200, 404, etc).

Valid after call().

Returns

The HTTP status code.

responseHeaders()

const UStringToUStringMultiMap & ts::RestClient::responseHeaders ( ) const

inline

Get all response headers.

Valid after call(), until next call() or this instance is destroyed.

Returns

A constant reference to a map of response headers.

mimeType()

UString ts::RestClient::mimeType ( bool  simple = true, bool  lowercase = true  ) const

inline

Get the MIME type in the response headers.

Valid after call().

Parameters

[in]	simple	If true, simple type name. If false, return the full specification with options.
[in]	lowercase	Force lowercase in the result.

Returns

The MIME type.

response()

const ByteBlock & ts::RestClient::response ( ) const

inline

Get the response in binary format.

Valid after call(), until next call() or this instance is destroyed.

Returns

A constant reference to binary response.

getResponseText()

void ts::RestClient::getResponseText

(

UString &

response

)

const

Get the response in text form (interpreted from UTF-8).

Valid after call().

Parameters

[out]

response

Response in text form. All CR/LF are turned into simple LF. The last end-of-line, if any, is removed.

getResponseJSON()

bool ts::RestClient::getResponseJSON

(

json::ValuePtr &

value

)

const

Get the response in JSON form.

Valid after call().

Parameters

[out]

value

Response in JSON form.

Returns

True on success, false on error (typically when the returned data are not valid JSON).

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]

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 )

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.

---

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

• tsRestClient.h