QorusConnectionProvider Namespace Reference

the QorusConnectionProvider namespace contains all the objects in the QorusConnectionProvider module More...

Functions
ConnectionProvider::AbstractConnection	get_mod_connection (string conn)
	returns a hash the given user connection or remote connection More...
*hash< string, AbstractConnection >	get_mod_connections ()
	returns a hash for all available user connections and remote connections keyed by identifier or NOTHING if no connections are available More...

Detailed Description

the QorusConnectionProvider namespace contains all the objects in the QorusConnectionProvider module

Function Documentation

get_mod_connection()

ConnectionProvider::AbstractConnection QorusConnectionProvider::get_mod_connection

(

string

conn

)

returns a hash the given user connection or remote connection

Example:

hash h = get_mod_url_info(conn);

Parameters

conn	the user connection or remote connection identifier or the special "qorus" connnection, providing a connection to the local Qorus instance

Returns

an AbstractConnection object for the given user connection or remote connection if the connection is valid and defined, otherwise an exception is thrown; an HttpConnection to the local instance (with non API path) is returned if the argument is "qorus"

Exceptions

CONNECTION-ERROR

cannot match identifier to a known connection

Note

• user connections take precedence over Qorus remote connections; in case of a name conflict, info for the user connection is returned
• if a user or remote connection is defined with the name "qorus", then that connection will be returned instead of the local connection object; it's recommended not to use "qorus" for a user or remote connection name

get_mod_connections()

*hash< string, AbstractConnection > QorusConnectionProvider::get_mod_connections

(

)

returns a hash for all available user connections and remote connections keyed by identifier or NOTHING if no connections are available

Example:

*hash h = get_mod_connections();

Returns

a hash for all available user connections and remote connections keyed by identifier; values are AbstractConnection objects. The default "qorus" HttpConnection object (with no API path) to the local instance is always returned if there are no connections.

Note

• user connections take precedence over Qorus remote connections; in case of a name conflict, the connection for the user connection is returned
• if a user or remote connection is defined with the name "qorus", then that connection will be returned instead of the local connection object; it's recommended not to use "qorus" for a user or remote connection name