this is the main include file for the Qorus client library More...

Classes
class	OMQ::QorusHttpRequestHandler
	helper class for consistent auditing and logging from system HTTP handlers; this class has a different implementation in the server More...

class	OMQ::DefaultQorusRBACAuthenticator
	this class does nothing in the client library; it is a placeholder for HttpServer::AbstractAuthenticator More...

Functions
deprecated hash	omq_read_option_file ()
	DEPRECATED: backwards-compatible option parsing - parses everything into a single hash. More...

deprecated	parse_dbparams ()
	DEPRECATED backwards-compatible function. More...

deprecated	process_datasource (string $line)
	DEPRECATED: backwards-compatible function. More...

deprecated Datasource	get_datasource (string $name)
	DEPRECATED: backwards-compatible function. More...

	open_datasources ()
	opens all system datasource and any optional list of datasources given to the function

string	getWarningString (hash $ex)
	returns a string representing a warning from an exception hash More...

string	get_next_sequence_value (string $name)
	returns the next value of the given sequence from the system "omq" datasource as a string More...

int	get_next_sequence_value_int (string $name)
	returns the next value of the given sequence from the system "omq" datasource as an int More...

list	insert_in_list (list $list, any $val, int $pos)
	inserts an element in a list More...

list	insert_in_list (reference $list, any $val, int $pos)
	inserts an element in a list More...

hash	remove_key (hash $hash, string $key)
	removes a key from a hash More...

int	get_index (list $list, any $val)
	returns the index of the first element in the list that matches the 2nd argument with soft comparisons

bool	lists_equal_ignore_order (list $list1, list $list2)
	returns True if the two list arguments are equal ignoring the order of the elements with soft comparisons

bool	lists_equal_ignore_order_hard (list $list1, list $list2)
	returns True if the two list arguments are equal ignoring the order of the elements with hard comparisons

bool	list_subset (list $small, list $big)
	returns True if $small only has elements that are present in $big ($small <= $big) with soft comparisons More...

bool	list_subset (any $small, list $big)
	returns True if $small is in $big (or $big is empty and $small is NOTHING) otherwise returns False; uses soft comparisons More...

bool	list_subset_hard (list $small, list $big)
	returns True if $small only has elements that are present in $big ($small <= $big) with hard comparisons More...

bool	list_subset_hard (any $small, list $big)
	returns True if $small is in $big (or $big is empty and $small is NOTHING) otherwise returns False; uses hard comparisons More...

deprecated *string	get_program_name ()
	returns the current script name More...

bool	unique_elements (list $l, any $dup)
	returns True if the list has all unique elements; uses soft comparisons

bool	unique_elements_hard (list $l, any $dup)
	returns True if the list has all unique elements; uses hard comparisons

Variables
hash	$Qorus
	global thread-local variable More...

Detailed Description

this is the main include file for the Qorus client library

Function Documentation

deprecated Datasource get_datasource ( string $name )

DEPRECATED: backwards-compatible function.

Deprecated:: use $omqclient.getDatasource() instead

string get_next_sequence_value ( string $name )

returns the next value of the given sequence from the system "omq" datasource as a string

assumes ::$omqclient.initSystemDatasources() has already been called

Parameters

$name the name of the sequence to use

Returns: the next value of the given sequence from the system "omq" datasource as a string

See also: OMQ::QorusClientAPI::initSystemDatasources()

int get_next_sequence_value_int ( string $name )

returns the next value of the given sequence from the system "omq" datasource as an int

assumes ::$omqclient.initSystemDatasources() has already been called

Parameters

$name the name of the sequence to use

Returns: the next value of the given sequence from the system "omq" datasource as a string

See also: OMQ::QorusClientAPI::initSystemDatasources()

deprecated *string get_program_name ( )

returns the current script name

Deprecated:: use standard Qore function get_script_name() instead

string getWarningString ( hash $ex )

returns a string representing a warning from an exception hash

Parameters

$ex	an exception hash

Returns: a string representing a warning

list insert_in_list	(	list	$list,
		any	$val,
		int	$pos
	)

inserts an element in a list

Deprecated:: use qore's splice operator instead; it's faster and standard Qore functionality

list insert_in_list	(	reference	$list,
		any	$val,
		int	$pos
	)

inserts an element in a list

Deprecated:: use qore's splice operator instead; it's faster and standard Qore functionality

bool list_subset	(	list	$small,
		list	$big
	)

returns True if $small only has elements that are present in $big ($small <= $big) with soft comparisons

See also: list_subset_hard()

bool list_subset	(	any	$small,
		list	$big
	)

returns True if $small is in $big (or $big is empty and $small is NOTHING) otherwise returns False; uses soft comparisons

See also: list_subset_hard()

bool list_subset_hard	(	list	$small,
		list	$big
	)

returns True if $small only has elements that are present in $big ($small <= $big) with hard comparisons

See also: list_subset()

bool list_subset_hard	(	any	$small,
		list	$big
	)

returns True if $small is in $big (or $big is empty and $small is NOTHING) otherwise returns False; uses hard comparisons

See also: list_subset()

deprecated hash omq_read_option_file ( )

DEPRECATED: backwards-compatible option parsing - parses everything into a single hash.

Deprecated:: use qorus_parse_options() instead

deprecated parse_dbparams ( )

DEPRECATED backwards-compatible function.

Deprecated:: it is not necessary to call this function directly anymore; just call qorus_client_init() or qorus_client_init2() and then ::$omqclient.getDatasource(), etc

deprecated process_datasource ( string $line )

DEPRECATED: backwards-compatible function.

Deprecated:: use $omqclient.setDatasourceFromText() instead

hash remove_key	(	hash	$hash,
		string	$key
	)

removes a key from a hash

Deprecated:: use the "-" operator instead (hash - string); it is faster and standard Qore functionality

Variable Documentation

hash $Qorus

global thread-local variable

fake server application variable

Classes

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation