NUGU HTTP Rest. More...

#include <nugu_http_rest.hh>

Public Types
typedef std::function< void(const NuguHttpResponse *resp)>	ResponseCallback
	Callback prototype for receiving async response.

Public Member Functions
bool	addHeader (const std::string &key, const std::string &value)
	Add a key-value string to common header. More...

bool	del (const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb)
	HTTP DELETE async requests. More...

NuguHttpResponse *	del (const std::string &path, const NuguHttpHeader *additional_header=nullptr)
	HTTP DELETE requests. More...

bool	del (const std::string &path, ResponseCallback cb)
	HTTP DELETE async requests. More...

std::string	findHeader (const std::string &key)
	Find a value for key from common header. More...

bool	get (const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb)
	HTTP GET async requests. More...

NuguHttpResponse *	get (const std::string &path, const NuguHttpHeader *additional_header=nullptr)
	HTTP GET requests. More...

bool	get (const std::string &path, ResponseCallback cb)
	HTTP GET async requests. More...

std::string	getUrl ()
	Get the url of host. More...

	NuguHttpRest (const std::string &url)

bool	post (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb)
	HTTP POST async requests. More...

NuguHttpResponse *	post (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr)
	HTTP POST requests. More...

bool	post (const std::string &path, const std::string &body, ResponseCallback cb)
	HTTP POST async requests. More...

bool	put (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb)
	HTTP PUT async requests. More...

NuguHttpResponse *	put (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr)
	HTTP PUT requests. More...

bool	put (const std::string &path, const std::string &body, ResponseCallback cb)
	HTTP PUT async requests. More...

bool	removeHeader (const std::string &key)
	Remove a key-value from common header. More...

void	setConnectionTimeout (long msecs)
	Set connection timeout to host. More...

void	setTimeout (long msecs)
	Set timeout to host. More...

Detailed Description

NUGU HTTP Rest.

Member Function Documentation

◆ setTimeout()

void NuguClientKit::NuguHttpRest::setTimeout ( long msecs )

Set timeout to host.

Parameters

[in] msecs millisecond

◆ setConnectionTimeout()

void NuguClientKit::NuguHttpRest::setConnectionTimeout ( long msecs )

Set connection timeout to host.

Parameters

[in] msecs millisecond

◆ getUrl()

std::string NuguClientKit::NuguHttpRest::getUrl ( )

Get the url of host.

Returns: url

◆ addHeader()

bool NuguClientKit::NuguHttpRest::addHeader	(	const std::string &	key,
		const std::string &	value
	)

Add a key-value string to common header.

Parameters

[in]	key	key string, e.g. "Content-Type"
[in]	value	value string, e.g. "application/json"

Returns: result

Return values

true	success
false	failure

◆ removeHeader()

bool NuguClientKit::NuguHttpRest::removeHeader ( const std::string & key )

Remove a key-value from common header.

Parameters

[in] key key string, e.g. "Content-Type"

Returns: result

Return values

true	success
false	failure

◆ findHeader()

std::string NuguClientKit::NuguHttpRest::findHeader ( const std::string & key )

Find a value for key from common header.

Parameters

[in] key key string, e.g. "Content-Type"

Returns: value

◆ get() [1/3]

NuguHttpResponse* NuguClientKit::NuguHttpRest::get	(	const std::string &	path,
		const NuguHttpHeader *	additional_header = `nullptr`
	)

HTTP GET requests.

Parameters

[in]	path	url path
[in]	additional_header	additional header

Returns: HTTP response object

See also: nugu_http_response_free()

◆ get() [2/3]

bool NuguClientKit::NuguHttpRest::get	(	const std::string &	path,
		ResponseCallback	cb
	)

HTTP GET async requests.

Parameters

[in]	path	url path
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ get() [3/3]

bool NuguClientKit::NuguHttpRest::get	(	const std::string &	path,
		const NuguHttpHeader *	additional_header,
		ResponseCallback	cb
	)

HTTP GET async requests.

Parameters

[in]	path	url path
[in]	additional_header	additional header
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ post() [1/3]

NuguHttpResponse* NuguClientKit::NuguHttpRest::post	(	const std::string &	path,
		const std::string &	body,
		const NuguHttpHeader *	additional_header = `nullptr`
	)

HTTP POST requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	additional_header	additional header

Returns: HTTP response object

See also: nugu_http_response_free()

◆ post() [2/3]

bool NuguClientKit::NuguHttpRest::post	(	const std::string &	path,
		const std::string &	body,
		ResponseCallback	cb
	)

HTTP POST async requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ post() [3/3]

bool NuguClientKit::NuguHttpRest::post	(	const std::string &	path,
		const std::string &	body,
		const NuguHttpHeader *	additional_header,
		ResponseCallback	cb
	)

HTTP POST async requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	additional_header	additional header
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ put() [1/3]

NuguHttpResponse* NuguClientKit::NuguHttpRest::put	(	const std::string &	path,
		const std::string &	body,
		const NuguHttpHeader *	additional_header = `nullptr`
	)

HTTP PUT requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	additional_header	additional header

Returns: HTTP response object

See also: nugu_http_response_free()

◆ put() [2/3]

bool NuguClientKit::NuguHttpRest::put	(	const std::string &	path,
		const std::string &	body,
		ResponseCallback	cb
	)

HTTP PUT async requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ put() [3/3]

bool NuguClientKit::NuguHttpRest::put	(	const std::string &	path,
		const std::string &	body,
		const NuguHttpHeader *	additional_header,
		ResponseCallback	cb
	)

HTTP PUT async requests.

Parameters

[in]	path	url path
[in]	body	body data to send
[in]	additional_header	additional header
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ del() [1/3]

NuguHttpResponse* NuguClientKit::NuguHttpRest::del	(	const std::string &	path,
		const NuguHttpHeader *	additional_header = `nullptr`
	)

HTTP DELETE requests.

Parameters

[in]	path	url path
[in]	additional_header	additional header

Returns: HTTP response object

See also: nugu_http_response_free()

◆ del() [2/3]

bool NuguClientKit::NuguHttpRest::del	(	const std::string &	path,
		ResponseCallback	cb
	)

HTTP DELETE async requests.

Parameters

[in]	path	url path
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

◆ del() [3/3]

bool NuguClientKit::NuguHttpRest::del	(	const std::string &	path,
		const NuguHttpHeader *	additional_header,
		ResponseCallback	cb
	)

HTTP DELETE async requests.

Parameters

[in]	path	url path
[in]	additional_header	additional header
[in]	cb	callback function to receive response

Returns: result

Return values

true	success
false	failure

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

nugu_http_rest.hh

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ setTimeout()

◆ setConnectionTimeout()

◆ getUrl()

◆ addHeader()

◆ removeHeader()

◆ findHeader()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ post() [1/3]

◆ post() [2/3]

◆ post() [3/3]

◆ put() [1/3]

◆ put() [2/3]

◆ put() [3/3]

◆ del() [1/3]

◆ del() [2/3]

◆ del() [3/3]