Client request for an InfluxDB server. More...

#include <tsInfluxRequest.h>

Inheritance diagram for ts::InfluxRequest:

[legend]

Collaboration diagram for ts::InfluxRequest:

[legend]

Public Member Functions
	InfluxRequest (const InfluxArgs &args)
	Constructor.

	InfluxRequest (Report *report, const InfluxArgs &args)
	Constructor.

	InfluxRequest (ReporterBase *delegate, const InfluxArgs &args)
	Constructor.

virtual	~InfluxRequest () override
	Destructor.

void	abort ()
	Abort a transfer in progress.

void	add (const UString &measurement, const UString &tags, const UString &fields)
	Add a line in the request being built, with generic value fields.

template<typename INT_T > requires std::integral<INT_T>
void	add (const UString &measurement, const UString &tags, INT_T value)
	Add a line in the request being built, with one single integer value.

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	close ()
	Close the transfer.

const UString &	currentContent () const
	Get the current content of the request being built.

bool	downloadBinaryContent (const UString &url, ByteBlockPtr &data, size_t chunk_size=Device::DEFAULT_RECEIVE_BUFFER_SIZE)
	Download the content of the URL as binary data in one operation.

bool	downloadFile (const UString &url, const fs::path &file_name, size_t chunk_size=Device::DEFAULT_RECEIVE_BUFFER_SIZE)
	Download the content of the URL in a file in one operation.

bool	downloadTextContent (const UString &url, UString &text, size_t chunk_size=Device::DEFAULT_RECEIVE_BUFFER_SIZE)
	Download the content of the URL as text in one operation.

bool	isOpen () const
	Check if a transfer is open.

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

bool	open (const UString &url, size_t buffer_size=Device::DEFAULT_RECEIVE_BUFFER_SIZE)
	Open an URL and start the transfer.

bool	receive (void *buffer, size_t max_size, size_t &ret_size)
	Receive data.

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

bool	send ()
	Complete the request being built and send it to the InfluxDB server.

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.

void	start (const Time &timestamp)
	Start building a request to the InfluxDB server.

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

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

static UString	ToKey (const UString &name)
	Escape characters in a string to be used as tag key, tag value, or field key.

static UString	ToMeasurement (const UString &name)
	Escape characters in a string to be used as measurement.

static UString	ToStringValue (const UString &name)
	Escape characters in a string to be used as field value of type string.

Detailed Description

Client request for an InfluxDB server.

See also: https://docs.influxdata.com/influxdb/v2/; https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/; https://docs.influxdata.com/influxdb/v2/api/v2/#operation/PostWrite

Constructor & Destructor Documentation

◆ InfluxRequest() [1/3]

ts::InfluxRequest::InfluxRequest ( const InfluxArgs & args )

explicit

Constructor.

Parameters

[in] args The connection information to the InfluxDB server. A reference is kept in this object.

◆ InfluxRequest() [2/3]

ts::InfluxRequest::InfluxRequest	(	Report *	report,
		const InfluxArgs &	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	The connection information to the InfluxDB server. A reference is kept in this object.

◆ InfluxRequest() [3/3]

ts::InfluxRequest::InfluxRequest	(	ReporterBase *	delegate,
		const InfluxArgs &	args
	)

Constructor.

Parameters

[in]	delegate	Use the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]	args	The connection information to the InfluxDB server. A reference is kept in this object.

Member Function Documentation

◆ start()

void ts::InfluxRequest::start ( const Time & timestamp )

Start building a request to the InfluxDB server.

Parameters

[in] timestamp Value of the timestamp for that request.

◆ add() [1/2]

template<typename INT_T >
requires std::integral<INT_T>

void ts::InfluxRequest::add	(	const UString &	measurement,
		const UString &	tags,
		INT_T	value
	)

inline

Add a line in the request being built, with one single integer value.

Parameters

[in]	measurement	The name of the measurement.
[in]	tags	Comma-separated list of tags "name=value". The names and values must be compatible with the InfluxDB line protocol (use ToKey() if necessary.
[in]	value	The measurement value. The field name is implicitly "value".

◆ add() [2/2]

void ts::InfluxRequest::add	(	const UString &	measurement,
		const UString &	tags,
		const UString &	fields
	)

Add a line in the request being built, with generic value fields.

Parameters

[in]	measurement	The name of the measurement.
[in]	tags	Comma-separated list of tags "name=value". The names and values must be compatible with the InfluxDB line protocol (use ToKey() if necessary.
[in]	fields	The measurement fields. The field names and values must be compatible with the InfluxDB line protocol.

◆ currentContent()

const UString & ts::InfluxRequest::currentContent ( ) const

inline

Get the current content of the request being built.

For debug purpose only.

Returns: A constant reference to a string object containing the currnet content.

◆ send()

bool ts::InfluxRequest::send ( )

Complete the request being built and send it to the InfluxDB server.

Returns: True on success, false on error.

◆ ToMeasurement()

static UString ts::InfluxRequest::ToMeasurement ( const UString & name )

inlinestatic

Escape characters in a string to be used as measurement.

Parameters

[in] name The name to transform.

Returns: The transformed string with escaped special characters.

See also: https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/

◆ ToKey()

static UString ts::InfluxRequest::ToKey ( const UString & name )

inlinestatic

Escape characters in a string to be used as tag key, tag value, or field key.

Parameters

[in] name The name to transform.

Returns: The transformed string with escaped special characters.

See also: https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/

◆ ToStringValue()

static UString ts::InfluxRequest::ToStringValue ( const UString & name )

inlinestatic

Escape characters in a string to be used as field value of type string.

Do not use for numerical field values. This function adds surrounding quotes.

Parameters

[in] name The name to transform.

Returns: The transformed string with escaped special characters and surrounding quotes.

See also: https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/

◆ args() [1/2]

WebRequestArgs & ts::WebRequest::args ( )

inherited

Access the Web request arguments to get or set them.

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

◆ args() [2/2]

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

inherited

Access the Web request arguments to get them.

Returns: A const reference to the Web request arguments.

◆ status()

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

inherited

Access the Web request status.

Returns: A const reference to the Web request status.

◆ open()

bool ts::WebRequest::open	(	const UString &	url,
		size_t	buffer_size = `Device::DEFAULT_RECEIVE_BUFFER_SIZE`
	)

inherited

Open an URL and start the transfer.

For HTTP request, perform all redirections and get response headers.

Parameters

[in]	url	The complete URL to fetch.
[in]	buffer_size	Size of input buffers to receive data.

Returns: True on success, false on error.

◆ isOpen()

bool ts::WebRequest::isOpen ( ) const

inherited

Check if a transfer is open.

Returns: True if a transfer is open, false otherwise.

◆ receive()

bool ts::WebRequest::receive	(	void *	buffer,
		size_t	max_size,
		size_t &	ret_size
	)

inherited

Receive data.

Parameters

[out]	buffer	Address of the buffer for the received data.
[in]	max_size	Size in bytes of the reception buffer.
[out]	ret_size	Size in bytes of the received data. Will never be larger than max_size. When ret_size is zero, this is the end of the transfer.

Returns: True on success, false on error. A successful end of transfer is reported when ret_size is zero and the returned value is true.

◆ close()

bool ts::WebRequest::close ( )

inherited

Close the transfer.

Returns: True on success, false on error.

◆ abort()

void ts::WebRequest::abort ( )

inherited

Abort a transfer in progress.

Can be called from another thread.

◆ downloadBinaryContent()

bool ts::WebRequest::downloadBinaryContent	(	const UString &	url,
		ByteBlockPtr &	data,
		size_t	chunk_size = `Device::DEFAULT_RECEIVE_BUFFER_SIZE`
	)

inherited

Download the content of the URL as binary data in one operation.

The open/read/close session is embedded in this method. The request must be in blocking mode (the default).

Parameters

[in]	url	The complete URL to fetch.
[out]	data	The content of the URL in a shred pointer. Null in case of error.
[in]	chunk_size	Individual download chunk size.

Returns: True on success, false on error.

◆ downloadTextContent()

bool ts::WebRequest::downloadTextContent	(	const UString &	url,
		UString &	text,
		size_t	chunk_size = `Device::DEFAULT_RECEIVE_BUFFER_SIZE`
	)

inherited

Download the content of the URL as text in one operation.

The open/read/close session is embedded in this method.. The downloaded text is converted from UTF-8. End of lines are normalized as LF. The request must be in blocking mode (the default).

Parameters

[in]	url	The complete URL to fetch.
[out]	text	The content of the URL.
[in]	chunk_size	Individual download chunk size.

Returns: True on success, false on error.

◆ downloadFile()

bool ts::WebRequest::downloadFile	(	const UString &	url,
		const fs::path &	file_name,
		size_t	chunk_size = `Device::DEFAULT_RECEIVE_BUFFER_SIZE`
	)

inherited

Download the content of the URL in a file in one operation.

The open/read/close session is embedded in this method.. No transformation is applied to the data. The request must be in blocking mode (the default).

Parameters

[in]	url	The complete URL to fetch.
[in]	file_name	Name of the file to create.
[in]	chunk_size	Individual download chunk size.

Returns: True on success, false on error.

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

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

tsInfluxRequest.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ InfluxRequest() [1/3]

◆ InfluxRequest() [2/3]

◆ InfluxRequest() [3/3]

Member Function Documentation

◆ start()

◆ add() [1/2]

◆ add() [2/2]

◆ currentContent()

◆ send()

◆ ToMeasurement()

◆ ToKey()

◆ ToStringValue()

◆ args() [1/2]

◆ args() [2/2]

◆ status()

◆ open()

◆ isOpen()

◆ receive()

◆ close()

◆ abort()

◆ downloadBinaryContent()

◆ downloadTextContent()

◆ downloadFile()

◆ report()

◆ setReport() [1/2]

◆ setReport() [2/2]

◆ muteReport()

◆ SilentLevel()