ts::InfluxSender Class Reference

Asynchronously send requests to an InfluxDB server. More...

#include <tsInfluxSender.h>

Inheritance diagram for ts::InfluxSender:

Collaboration diagram for ts::InfluxSender:

Public Member Functions
	InfluxSender (Report *report=nullptr, Object *owner=nullptr)
	Constructor.
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.
Report &	report () const
	Access the Report which is associated with this object.
bool	send (InfluxRequestPtr &request)
	Asynchronously send an InfluxDB 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	start (const InfluxArgs &args)
	Start the asynchronous sender.
void	stop ()
	Stop the asynchronous sender.

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

Private Member Functions
bool	start ()
	Start the thread.

Detailed Description

Asynchronously send requests to an InfluxDB server.

We cannot anticipate the response time of the server. Using a thread avoid slowing down the packet transmission.

Constructor & Destructor Documentation

InfluxSender()

ts::InfluxSender::InfluxSender	(	Report *	report = nullptr,
		Object *	owner = nullptr
	)

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]	owner	Optional address of an "owner" object, typically an instance of class containing this object.

Member Function Documentation

start()

bool ts::InfluxSender::start

(

const InfluxArgs &

args

)

Start the asynchronous sender.

Parameters

[in]

args

Connection parameters to the InfluxDB server.

Returns

True on success, false on error.

stop()

void ts::InfluxSender::stop

(

)

Stop the asynchronous sender.

Wait for the internal thread to terminate.

send()

bool ts::InfluxSender::send

(

InfluxRequestPtr &

request

)

Asynchronously send an InfluxDB request.

Parameters

[in,out]

request

Smart pointer to the request. The ownership of the pointer is transfered to the asynchronous sender. The parameter is nullified on return.

Returns

True if the request was queued. False in case of queue overflow.

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.

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

OBJECT

A subclass of Object

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

OBJECT

A subclass of Object

Returns

True if this object has an owner by an object of type OBJECT, false otherwise.

---

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

• tsInfluxSender.h