Qore ConnectionProvider Module Reference 1.9.2
Loading...
Searching...
No Matches
ConnectionProvider::HttpConnection Class Reference

class for HTTP connections; returns Qore::HTTPClient objects More...

#include <HttpConnection.qc.dox.h>

Inheritance diagram for ConnectionProvider::HttpConnection:
[legend]

Public Member Methods

 constructor (string name, string desc, string url, hash< auto > attributes={}, hash< auto > options={})
 Creates the HttpConnection object. More...
 
DataProvider::AbstractDataProvider getDataProvider ()
 Returns an HttpDataProvider object for this connection. More...
 
string getType ()
 Returns "http".
 
bool hasDataProvider ()
 Returns True, as the connection returns a data provider with the getDataProvider() method. More...
 
Qore::AbstractPollOperation startPollConnect ()
 Called to start the connection if the connection supports the polling API. More...
 
bool supportsPollingApi ()
 returns True, since this connection type supports the Qore Socket-based polling API More...
 
- Public Member Methods inherited from ConnectionProvider::AbstractConnectionWithInfo
 constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
 creates the AbstractConnection object More...
 
hash< ConnectionSchemeInfogetConnectionSchemeInfo ()
 Returns the ConnectionSchemeInfo hash for this object.
 
*hash< auto > getDefaultOptions ()
 returns default options
 
*hash< auto > getOptions ()
 returns static / initialization options
 
- Public Member Methods inherited from ConnectionProvider::AbstractConnection
deprecated constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh, *string safe_url, *bool enabled)
 creates the AbstractConnection object More...
 
 constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
 creates the AbstractConnection object More...
 
object get (bool connect=True, *hash< auto > rtopts)
 returns the underlying connection object More...
 
hash< ConfigInfogetConfigHash ()
 returns a ConfigInfo hash of static configuration information about the connection More...
 
hash< ConnectionSchemeInfogetConnectionSchemeInfo ()
 Returns a default ConnectionSchemeInfo hash.
 
hash< ConnectionSchemeInfogetConnectionSchemeInfoImpl ()
 Override in subclasses to return a native ConnectionSchemeInfo hash.
 
AbstractDataProvider getDataProvider ()
 returns a data provider object for this connection, if supported More...
 
*hash< auto > getDefaultOptions ()
 returns default options
 
string getDescription ()
 Returns the connection description. More...
 
hash< auto > getExtendedInfo (*hash< auto > opts)
 Returns connection info plus any extended information returned by the connection. More...
 
hash< ConnectionInfogetInfo (*hash< auto > opts)
 returns a ConnectionInfo hash of information about the connection More...
 
hash< ConnectionInfogetInfo (bool with_password=False)
 returns a ConnectionInfo hash of information about the connection More...
 
string getName ()
 Returns the connection name. More...
 
*hash< auto > getOptions ()
 returns static / initialization options
 
object getPollImpl ()
 Returns an unconnected object for a non-blocking poll operation. More...
 
*hash< auto > getRealOptions ()
 returns options for saving the connection's configuration information
 
*hash< auto > getRuntimeOptions ()
 returns runtime options
 
string getSafeUrl ()
 Returns the connection safe URL (without password info) More...
 
auto getTag (string tag)
 returns the value of the given tag or NOTHING if not present
 
auto getTagEx (string tag)
 returns the value of the given tag or throws an exception if the tag is not set with a value More...
 
hash< auto > getTags ()
 returns all tags associated with the connection
 
abstract string getType ()
 returns the string type name for the connection object
 
string getUrl ()
 Returns the connection URL. More...
 
 handlePingFailed (date delta, hash< ExceptionInfo > ex)
 Handles a failed ping operation on the connection.
 
 handlePingFailed (date delta, string err)
 Handles a failed ping operation on the connection.
 
 handlePingSuccess (date delta)
 Handles a successful ping operation on the connection.
 
bool hasDataProvider ()
 returns True if the connection returns a data provider with the getDataProvider() method More...
 
 parseTextOptions ()
 this method is called when parsing connection file definitions from text files when loading into the database More...
 
hash< PingInfoping (bool throw_exception=False)
 returns a hash with the results of the ping operation More...
 
Qore::AbstractPollOperation startPollConnect ()
 Called to start the connection polling operation. More...
 
bool supportsPollingApi ()
 returns True if the connection supports the Qore Socket-based polling API More...
 

Public Attributes

const ConnectionScheme
 Connection entry info.
 
const Options = map {$1: True}
 HttpConnection object connection options.
 
- Public Attributes inherited from ConnectionProvider::AbstractConnection
bool children_can_support_apis = False
 if the data provider or any of its children support requests (APIs)
 
bool children_can_support_messages = False
 if the data provider or any of its children support messages
 
bool children_can_support_observers = False
 if the data provider or any of its children support events
 
bool children_can_support_records = False
 if the data provider or any of its children support records
 
bool children_can_support_transactions = False
 if the data provider or any of its children support transaction management
 
bool debug_data = False
 debug data flag; to be used an an indication for a higher-level implementation
 
string desc
 connection description
 
bool enabled = True
 enabled/disabled indicator flag
 
hash< auto > internal_info
 internal tags (serializable)
 
date last_check
 date/time of last check/ping
 
bool locked = False
 locked/unlocked flag
 
bool loopback = False
 set to True for loopback connections
 
bool monitor
 monitoring flag
 
string name
 connection name
 
*hash< auto > opts
 connection options
 
*hash< auto > orig_opts
 original connection options
 
string safe_url
 "safe" URL (password information removed)
 
string status = "not checked"
 status string; in case of a connection error this string will be the error string
 
hash< auto > tags = {}
 connection tags; user-defined key-value pairs
 
transient hash< auto > transient_info
 internal transient tags (non-serializable)
 
bool up = False
 connection status flag; set by monitoring or explicit pings/connections
 
date updated
 date/time of last update
 
string url
 connection URL (potentially with password info)
 
hash< auto > urlh
 broken down URL hash (as returned by Qore::parse_url())
 

Private Member Methods

hash< ConnectionSchemeInfogetConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 
Qore::HTTPClient getImpl (bool connect=True, *hash< auto > rtopts)
 returns an Qore::HTTPClient object More...
 
 setChildCapabilities ()
 Sets child data provider capabilities.
 
abstract hash< ConnectionSchemeInfogetConnectionSchemeInfoImpl ()
 Returns the ConnectionSchemeInfo hash for this object.
 
- Private Member Methods inherited from ConnectionProvider::AbstractConnection
abstract object getImpl (bool connect=True, *hash< auto > rtopts)
 this method must return the connection object corresponding to the object's configuration More...
 
string getSafeUrl (hash< auto > urlh)
 creates a "safe" URL string with password information removed More...
 
hash< UrlInfo > parseUrl (string url)
 Parse the URL to a hash. More...
 
 pingImpl ()
 performs the internal ping More...
 
hash< PingInfopingIntern (hash< PingInfo > rv)
 performs the ping by executing get(); returns a PingInfo hash
 
 setChildCapabilities ()
 Override to set child data provider capabilities once per child class.
 
hash< auto > validateOptions (hash< auto > options)
 performs options validation in the constructor More...
 

Additional Inherited Members

- Static Public Attributes inherited from ConnectionProvider::AbstractConnection
static *code post_processing
 optional code for default post-processing of objects created by getImpl() More...
 

Detailed Description

class for HTTP connections; returns Qore::HTTPClient objects

Supports the following options:

  • "assume_encoding": assumes the given encoding if the server does not send a charset value
  • "connect_timeout": connection timeout to use in milliseconds (default: 45 seconds)
  • "error_passthru": if True then HTTP status codes indicating errors will not cause an HTTP-CLIENT-RECEIVE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
  • "headers": headers to add in each outgoing request
  • "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
  • "max_redirects": maximum redirects to support
  • "pre_encoded_urls": If True then all URI paths in URLs are assumed to be already percent encoded; if this flag is set and any unencoded characters are sent in a URL with a new request, an exception is raised
  • "proxy": proxy URL to use
  • "redirect_passthru": if True then redirect responses will be passed to the caller instead of processed
  • "ssl_cert_path": a path to an X.509 client certificate file in PEM format
  • "ssl_key_path": a path to a private key file in PEM format for the X.509 client certificate
  • "ssl_key_password": the password to the private key given with "ssl_key_path"
  • "ssl_verify_cert": if True then the server's certificate will only be accepted if it's verified
  • "timeout": transfer timeout to use in milliseconds (default: 45 seconds)
See also
HTTPClient::constructor(hash<auto> opts) for more information on the above options

Member Function Documentation

◆ constructor()

ConnectionProvider::HttpConnection::constructor ( string  name,
string  desc,
string  url,
hash< auto >  attributes = {},
hash< auto >  options = {} 
)

Creates the HttpConnection object.

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

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

Exceptions
CONNECTION-OPTION-ERRORmissing or invalid connection option

◆ getDataProvider()

DataProvider::AbstractDataProvider ConnectionProvider::HttpConnection::getDataProvider ( )

Returns an HttpDataProvider object for this connection.

Returns
an HttpDataProvider object for this connection
See also
hasDataProvider()

◆ getImpl()

Qore::HTTPClient ConnectionProvider::HttpConnection::getImpl ( bool  connect = True,
*hash< auto >  rtopts 
)
privatevirtual

returns an Qore::HTTPClient object

Parameters
connectif True then a connection is made by calling Qore::HTTPClient::connect() before returning the object
rtoptsthis connection type does not accept any runtime option, so this parameter is ignored

Implements ConnectionProvider::AbstractConnection.

◆ hasDataProvider()

bool ConnectionProvider::HttpConnection::hasDataProvider ( )

Returns True, as the connection returns a data provider with the getDataProvider() method.

Returns
True, as the connection returns a data provider with the getDataProvider() method
See also
getDataProvider()

◆ startPollConnect()

Qore::AbstractPollOperation ConnectionProvider::HttpConnection::startPollConnect ( )

Called to start the connection if the connection supports the polling API.

Returns
a socket poll operation object that will allow the connection goal to be reached with polling
See also
supportsPollingApi()
Since
ConnectionProvider 1.7

◆ supportsPollingApi()

bool ConnectionProvider::HttpConnection::supportsPollingApi ( )

returns True, since this connection type supports the Qore Socket-based polling API

Returns
True
Since
ConnectionProvider 1.7