Qorus API Functions in the Client and Server

Functions
list< auto >	OMQ::UserApi::remove_from_list (list< auto > list, auto val)
	uses the select operator to remove all occurences of a value from a list More...
list< auto >	OMQ::UserApi::remove_from_list (reference list, auto val)
	uses the select operator to remove all occurences of a value from a list More...
string	OMQ::UserApi::xml_change_encoding (string xml, string enc)
	returns a string with the XML encoding name changed to that given as an argument More...
string	OMQ::UserApi::xml_get_encoding (string xml)
	returns the XML encoding name given in the string (not the actual string encoding, which may be different) More...
string	OMQ::UserApi::serialize_qorus_data (auto d)
	returns a string giving the default serialization of the given data structure for storage in Qorus More...
auto	OMQ::UserApi::deserialize_qorus_data (string data)
	parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data More...
string	OMQ::UserApi::get_salted_string (string str, binary salt)
	returns a string that has been x-ored with binary "salt" data
softint	OMQ::UserApi::next_sequence_value (AbstractDatasource ds, string name)
	returns the next sequence value for the given sequence
string	OMQ::UserApi::get_ds_desc (hash< auto > h, *int dd_opts)
	returns a datasource description string from a datasource configuration hash More...
list< hash< CallStackInfo > >	OMQ::UserApi::get_thread_call_stack ()
	allows Qore::get_thread_call_stack() to be called from Qorus interfaces More...

Detailed Description

Function Documentation

deserialize_qorus_data()

auto OMQ::UserApi::deserialize_qorus_data

(

string

data

)

parses serialized data in either XML-RPC or YAML format and returns the corresponding qore data

auto-detects XML-RPC or YAML decoding

Parameters

data	the string data to deserialize

Returns

the Qore data represented by the string arugment

get_ds_desc()

string OMQ::UserApi::get_ds_desc	(	hash< auto >	h,
		*int	dd_opts
	)

returns a datasource description string from a datasource configuration hash

Parameters

h	a datasource configuration hash as returned by AbstractDatasource::getConfigHash()
dd_opts	a bitfield of datasource description options; see Datasource Description Options for more information

Since

Qorus 4.0.0

get_thread_call_stack()

list< hash< CallStackInfo > > OMQ::UserApi::get_thread_call_stack

(

)

allows Qore::get_thread_call_stack() to be called from Qorus interfaces

The Qore function is normally prohibited from use in Qorus interfaces due to sandboxing restrictions

Since

Qorus 4.0.0.

remove_from_list() [1/2]

list< auto > OMQ::UserApi::remove_from_list	(	list< auto >	list,
		auto	val
	)

uses the select operator to remove all occurences of a value from a list

The following functions are available in the Qorus client and in all server contexts

Note

O(n) performance

remove_from_list() [2/2]

list< auto > OMQ::UserApi::remove_from_list	(	reference	list,
		auto	val
	)

uses the select operator to remove all occurences of a value from a list

Note

O(n) performance

serialize_qorus_data()

string OMQ::UserApi::serialize_qorus_data

(

auto

d

)

returns a string giving the default serialization of the given data structure for storage in Qorus

the default serialization is currently YAML

Parameters

d	the data to serialize

Returns

a YAML string representing the given data structure for storage in Qorus

xml_change_encoding()

string OMQ::UserApi::xml_change_encoding	(	string	xml,
		string	enc
	)

returns a string with the XML encoding name changed to that given as an argument

does not change the actual encoding of the string (which may be different)

xml_get_encoding()

string OMQ::UserApi::xml_get_encoding

(

string

xml

)

returns the XML encoding name given in the string (not the actual string encoding, which may be different)

Exceptions

XML-NO-HEADER	the XML string did not contain an XML header
XML-INVALID-HEADER	the XML string contained an invalid XML header