OMQ::StreamConfig Class Reference

stream configuration class More...

Inheritance diagram for OMQ::StreamConfig:

Collaboration diagram for OMQ::StreamConfig:

Public Member Methods
	constructor (string stream, string remote, *hash< auto > options)
	constructor taking a string giving the name of the remote connection for the remote server More...
	constructor (string stream, QorusSystemRestHelper remote, *hash< auto > options)
	constructor taking an OMQ::QorusSystemRestHelper object for the remote connection More...
	logStreamConfig (string what)
	logs the stream configuration when created
	logStreamConfigImpl (string what, string url)
	logs the stream configuration when created
string	stream ()
	returns the stream name
string	streamDesc ()
	returns a description of the stream for error reporting
QorusSystemRestHelper	remote ()
	returns the remote connection object (see OMQ::QorusSystemRestHelper)
timeout	timeout ()
	returns the timeout value in milliseconds
int	block ()
	returns the block size
bool	suppressRemoteTimeout ()
	returns True if no "timeout" option should be sent to the remote
	update (string stream, *hash< auto > options)
	updates the configuration for a new stream

Private Member Methods
	setOptions (*hash< auto > options)
	sets configuration values from an optional option hash
int	getDefaultBlockSize ()
	returns the default block size for this object (1000)

Private Attributes
string	m_stream
	no public members More...
QorusSystemRestHelper	m_remote
	real remote rest helper
timeout	m_timeout = 5m
	timeout for rest connections
bool	m_no_remote_timeout = False
	flag to suppress sending the timeout option to the remote
int	m_logLevel = LoggerLevel::INFO
	default log level; default LoggerLevel::INFO
softint	m_block
	block size

Detailed Description

stream configuration class

default values:

• m_timeout: 5m
• m_loglevel: LoggerLevel::INFO

Member Function Documentation

constructor() [1/2]

OMQ::StreamConfig::constructor	(	string	stream,
		QorusSystemRestHelper	remote,
		*hash< auto >	options
	)

constructor taking an OMQ::QorusSystemRestHelper object for the remote connection

Parameters

stream	a string giving the name of the stream that will be used
remote	a OMQ::QorusSystemRestHelper object
options	optional Streaming API Constructor Options as follows: "block": data block size "loglevel": a default log level option for logging; see Log Levels for valid value "no_remote_timeout": if True the "timeout" option will not be sent to the remote "timeout": an HTTP socket timeout value in milliseconds; used locally and in the remote for socket I/O and queue operations; default value: 5m

Note

the explicit or default timeout value here overrides any socket I/O timeout set for the remote connection object

constructor() [2/2]

OMQ::StreamConfig::constructor	(	string	stream,
		string	remote,
		*hash< auto >	options
	)

constructor taking a string giving the name of the remote connection for the remote server

Parameters

stream	a string giving the name of the stream that will be used
remote	a string giving the name of the remote connection for the remote server
options	optional Streaming API Constructor Options as follows: "block": data block size "loglevel": a default log level option for logging; see Log Levels for valid value "no_remote_timeout": if True the "timeout" option will not be sent to the remote "timeout": an HTTP socket timeout value in milliseconds; used locally and in the remote for socket I/O and queue operations; default value: 5m

Note

the explicit or default timeout value here overrides any socket I/O timeout set for the remote connection object

Member Data Documentation

m_stream

string OMQ::StreamConfig::m_stream

private

no public members

the remote sqlutil service stream

---

The documentation for this class was generated from the following file:

• Streams.qc