Qorus Integration Engine® Enterprise Edition 6.0.15_prod
|
objects that are also present in the server with the same names are created under the OMQ::Client namespace More...
Classes | |
class | ClientPropServiceMethodGateHelper |
this class provides an easy way to call service methods on a Qorus server; will redirect system property APIs to local DB-based functions in case Qorus is down More... | |
class | DatasourceConnections |
Qorus client library class used to handle DATASOURCE connections. More... | |
class | QorusClientSystemServiceHelper |
mid-level class in the client for transparently redirecting calls to services; will redirect system property APIs to local DB-based functions in case Qorus is down More... | |
class | QorusLocalRestHelper |
class for local REST API calls More... | |
class | QorusSystemAPIHelper |
class to call the system API from the client library More... | |
class | QorusSystemRestHelper |
class to call the system REST API from the client library More... | |
class | RemoteConnections |
Qorus client library class used to handle REMOTE connections. More... | |
class | UserConnections |
Qorus client library class to handle USER connections. More... | |
Functions | |
OMQ::Client::QorusSystemRestHelper | get_remote_rest_connection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection. More... | |
OMQ::Client::QorusSystemAPIHelper | get_remote_rpc_connection (string name, bool connect=True, bool register_dependency=True) |
Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection. More... | |
Qore::SQL::DatasourcePool | get_datasource_pool (string name, bool register_dependency=True) |
returns a DatasourcePool object for the given datasource name More... | |
Qore::SQL::Datasource | get_datasource_dedicated (string name, bool register_dependency=True) |
returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions More... | |
SqlUtil::AbstractTable | get_sql_table (string datasource, string table_name) |
creates and returns a table object; there is no cache implementation in the client; this function is here for compatibility with server code and convenience in the client library More... | |
SqlUtil::AbstractTable | get_sql_table (AbstractDatasource ds, string table_name) |
creates and returns a table object; there is no cache implementation in the client; this function is here for compatibility with server code and convenience in the client library More... | |
SqlUtil::AbstractTable | get_sql_table_system (string datasource, string table_name) |
in the client library equal to get_sql_table(string, string) More... | |
SqlUtil::AbstractTable | get_sql_table_system (AbstractDatasource ds, string table_name) |
in the client library equal to get_sql_table(AbstractDatasource, string) More... | |
object | get_user_connection (string name, bool connect=True, bool register_dependency=True, *hash rtopts) |
Returns an object corresponding to a defined user connection. More... | |
hash< auto > | prop_get () |
returns a hash of all system properties in all domains More... | |
*hash< auto > | prop_get (string domain) |
returns a hash of all key-value pairs in the given domain or NOTHING if the system property domain does not exist More... | |
auto | prop_get (string domain, string key) |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist More... | |
qorus_client_init () | |
the client initialization function where any errors cause an error message to be displayed and exit() is called More... | |
qorus_client_init2 () | |
the main client initialization function; other functions call this one to initialize the client library More... | |
hash | qorus_parse_options (string domain) |
option-parsing function: parses the option file More... | |
hash | qorus_parse_options () |
option-parsing function: parses the option file More... | |
auto | qorus_get_system_option (string opt) |
returns the value of the given Qorus system option (in the "qorus" domain) More... | |
hash | qorus_get_system_options () |
returns the value of all Qorus system options (in the "qorus" domain) More... | |
objects that are also present in the server with the same names are created under the OMQ::Client namespace
Qore::SQL::Datasource OMQ::Client::get_datasource_dedicated | ( | string | name, |
bool | register_dependency = True |
||
) |
returns a new, dedicated Datasource object, suitable for transaction management for long-running transactions
name | the name of the datasource |
register_dependency | unused in client code; it is here for server-side API compatibility. |
DATASOURCE-ERROR | The given connection is not known or is a system datasource |
Qore::SQL::DatasourcePool OMQ::Client::get_datasource_pool | ( | string | name, |
bool | register_dependency = True |
||
) |
returns a DatasourcePool object for the given datasource name
name | the name of the datasource |
register_dependency | unused in client code; it is here for server-side API compatibility. |
DATASOURCE-ERROR | unknown or system datasource |
OMQ::Client::QorusSystemRestHelper OMQ::Client::get_remote_rest_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True |
||
) |
Returns a new QorusSystemRestHelper object corresponding to a defined Qorus remote connection.
name | the name of the connection |
connect | unused in client code; it is here for server-side API compatibility. |
register_dependency | unused in client code; it is here for server-side API compatibility. |
GET-REMOTE-ERROR | The given connection is not known |
OMQ::Client::QorusSystemAPIHelper OMQ::Client::get_remote_rpc_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True |
||
) |
Returns a new QorusSystemAPIHelper object corresponding to a defined Qorus remote connection.
name | the name of the connection |
connect | unused in client code; it is here for server-side API compatibility. |
register_dependency | unused in client code; it is here for server-side API compatibility. |
GET-REMOTE-ERROR | The given connection is not known |
SqlUtil::AbstractTable OMQ::Client::get_sql_table | ( | AbstractDatasource | ds, |
string | table_name | ||
) |
creates and returns a table object; there is no cache implementation in the client; this function is here for compatibility with server code and convenience in the client library
ds | a Qore::SQL::AbstractDatasource object |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor() |
SqlUtil::AbstractTable OMQ::Client::get_sql_table | ( | string | datasource, |
string | table_name | ||
) |
creates and returns a table object; there is no cache implementation in the client; this function is here for compatibility with server code and convenience in the client library
datasource | a string with a name of a Datasource Connections |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor() |
INVALID-DATASOURCE | this exception is thrown if the datasource argument cannot be matched to a known Qorus datasourceā |
SqlUtil::AbstractTable OMQ::Client::get_sql_table_system | ( | AbstractDatasource | ds, |
string | table_name | ||
) |
in the client library equal to get_sql_table(AbstractDatasource, string)
SqlUtil::AbstractTable OMQ::Client::get_sql_table_system | ( | string | datasource, |
string | table_name | ||
) |
in the client library equal to get_sql_table(string, string)
datasource | the name of a valid Qorus datasource |
table_name | the name of the table to be acquired; the handling of this parameter is identical to that in SqlUtil::Table::constructor() |
object OMQ::Client::get_user_connection | ( | string | name, |
bool | connect = True , |
||
bool | register_dependency = True , |
||
*hash | rtopts | ||
) |
Returns an object corresponding to a defined user connection.
name | the name of the connection |
connect | if False an unconnected object will be returned, otherwise the object is already connected |
register_dependency | unused in client code; it is here for server-side API compatibility |
rtopts | any runtime options accepted by the connection |
CONNECTION-ERROR | The given connection is not known |
hash< auto > OMQ::Client::prop_get | ( | ) |
returns a hash of all system properties in all domains
*hash< auto > OMQ::Client::prop_get | ( | string | domain | ) |
auto OMQ::Client::prop_get | ( | string | domain, |
string | key | ||
) |
returns the value of the given system property key in the given domain or NOTHING if the system property does not exist
OMQ::Client::qorus_client_init | ( | ) |
the client initialization function where any errors cause an error message to be displayed and exit() is called
Actually implemented by QorusClient::init()
OMQ::Client::qorus_client_init2 | ( | ) |
the main client initialization function; other functions call this one to initialize the client library
Actually implemented by QorusClient::init2()
auto OMQ::Client::qorus_get_system_option | ( | string | opt | ) |
returns the value of the given Qorus system option (in the "qorus"
domain)
This function calls QorusClient::init() to ensure the client library is initialized
"qorus"
domain) or NOTHING if the option is not set or is unknownhash OMQ::Client::qorus_get_system_options | ( | ) |
returns the value of all Qorus system options (in the "qorus"
domain)
This function calls QorusClient::init() to ensure the client library is initialized
"qorus"
domainhash OMQ::Client::qorus_parse_options | ( | ) |
option-parsing function: parses the option file
Actually implemented by QorusClient::parseOptions()
This function calls QorusClient::init() to ensure the client library is initialized
hash OMQ::Client::qorus_parse_options | ( | string | domain | ) |
option-parsing function: parses the option file
Actually implemented by QorusClient::parseOptions()
This function calls QorusClient::init() to ensure the client library is initialized