Qore SewioRestClient Module Reference  1.2
SewioRestClient::SewioRestConnection Class Reference

class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects More...

Inheritance diagram for SewioRestClient::SewioRestConnection:

Public Member Methods

deprecated constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 DEPRECATED: creates the SewioRestConnection object. More...
 
 constructor (string name, string description, string url, hash attributes={}, hash options={})
 creates the SewioRestConnection object More...
 
*hash getDefaultOptions ()
 returns default options
 
hash getOptions ()
 gets options More...
 
string getType ()
 returns "sewiorest"
 

Static Public Member Methods

static deprecated SewioRestConnection make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 DEPRECATED: static constructor. More...
 

Public Attributes

const Options
 SewioRestConnection object connection options.
 

Private Member Methods

hash< ConnectionConstructorInfo > getConstructorInfoImpl ()
 returns a hash that can be used to construct the object dynamically More...
 
SewioRestClient getImpl (bool connect=True, *hash rtopts)
 returns a SewioRestClient::SewioRestClient object More...
 

Detailed Description

class for Sewio.net's RTLS Studio REST connections; returns SewioRestClient::SewioRestClient objects

supports the following options:

  • "apikey": (required) the Sewio.net's RTLS Studio api key
  • "connect_timeout": connection timeout to use in milliseconds
  • "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
  • "data": see DataSerializationOptions for possible values; the default is "json"
  • "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
  • "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "max_redirects": maximum redirects to support
  • "proxy": proxy URL to use
  • "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
  • "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
  • "timeout": transfer timeout to use in milliseconds
See also
SewioRestClient::constructor() for more information on the above options

Member Function Documentation

◆ constructor() [1/2]

deprecated SewioRestClient::SewioRestConnection::constructor ( string  name,
string  desc,
string  url,
bool  monitor,
*hash  opts,
hash  urlh 
)

DEPRECATED: creates the SewioRestConnection object.

Parameters
namethe name of the connection
descconnection description
urlconnection URL (potentially with password info)
monitormonitoring flag
optsconnection options
urlhbroken down URL hash (as returned by Qore::parse_url())
Exceptions
SEWIORESTCONNECTION-ERRORmissing apikey option
Deprecated:
since Qore 0.9

◆ constructor() [2/2]

SewioRestClient::SewioRestConnection::constructor ( string  name,
string  description,
string  url,
hash  attributes = {},
hash  options = {} 
)

creates the SewioRestConnection object

Parameters
namethe name of the connection
descriptionconnection description
urlconnection URL (potentially with password info)
attributesvarious attributes. See below
optionsconnection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions
SEWIORESTCONNECTION-ERRORmissing apikey option

◆ getConstructorInfoImpl()

hash<ConnectionConstructorInfo> SewioRestClient::SewioRestConnection::getConstructorInfoImpl ( )
privatevirtual

returns a hash that can be used to construct the object dynamically

Since
SewioRestClient 1.5

Reimplemented from RestClient::RestConnection.

◆ getImpl()

SewioRestClient SewioRestClient::SewioRestConnection::getImpl ( bool  connect = True,
*hash  rtopts 
)
privatevirtual

returns a SewioRestClient::SewioRestClient object

Parameters
connectif True, then the connection is returned already connected
rtoptsthis connection type does not accept any runtime options, so this parameter is ignored
Returns
a SewioRestClient object

Reimplemented from RestClient::RestConnection.

◆ getOptions()

hash SewioRestClient::SewioRestConnection::getOptions ( )

gets options

Returns
returns a hash with the following supported options:
  • "apikey": the Sewio.net's RTLS Studio API key in use
  • "connect_timeout": connection timeout to use in milliseconds
  • "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
  • "data": see RestClient::RestClient::DataSerializationOptions for possible values; the default is "json"
  • "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
  • "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "max_redirects": maximum redirects to support
  • "proxy": proxy URL to use
  • "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
  • "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
  • "timeout": transfer timeout to use in milliseconds
See also
SewioRestClient::constructor() for more information on the above options

◆ make()

static deprecated SewioRestConnection SewioRestClient::SewioRestConnection::make ( string  name,
string  desc,
string  url,
bool  monitor,
*hash  opts,
hash  urlh 
)
static

DEPRECATED: static constructor.

Deprecated:
since Qore 0.9 in favor of new constructor and Qore::Reflection