OMQ::FsReceiveStreamConfig Class Reference

filesystem receive stream base config class More...

Inheritance diagram for OMQ::FsReceiveStreamConfig:

Public Member Methods
	constructor (string remote, string path, string streamType=AbstractFsRemoteReceive::TYPE_FILE, *hash options)
	creates the configuration object from the arguments
	constructor (QorusSystemRestHelper remote, string path, string streamType=AbstractFsRemoteReceive::TYPE_FILE, *hash options)
	creates the configuration object from the arguments
private	setOptions (string path, string streamType, *hash options)
	sets configuration options
string	path ()
	returns the path
string	encoding ()
	returns the file's character encoding
private int	getDefaultBlockSize ()
	returns the default block size for this object (16384)
	logStreamConfigImpl (string what, string url)
	logs the stream configuration when created
	updatePath (string path)
	updates the stored path
Public Member Methods inherited from OMQ::StreamConfig
	constructor (string stream, string remote, *hash options)
	constructor taking a string giving the name of the remote connection for the remote server More...
	constructor (string stream, QorusSystemRestHelper remote, *hash 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
private	setOptions (*hash options)
	sets configuration values from an optional option hash
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 options)
	updates the configuration for a new stream
private int	getDefaultBlockSize ()
	returns the default block size for this object (1000)
Public Member Methods inherited from OMQ::QueuedBlockConfigBase
	constructor (*hash options)
	creates the object and assigns config info
*int	queueBlockSize ()
	returns the queue block size
int	queueTimeout ()
	returns the queue timeout in milliseconds
	update (*hash options)
	updates options

Private Attributes
string	m_path
	target path
string	m_encoding = get_default_encoding()
	target file encoding
const	MinBlockSize = 4096
	minimum block size in bytes
string	m_streamType
	One of supported stream types. See AbstractFsRemoteReceive public constants.
hash	m_csvUtilOpts
	Potential options for csv when is the m_streamType = AbstractFsRemoteReceive::TYPE_CSV;.
string	m_xmlElement
	Potential xml element for csv when is the m_streamType = AbstractFsRemoteReceive::TYPE_XML;.
Private Attributes inherited from OMQ::StreamConfig
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 = LL_INFO
	default log level; default LL_INFO
softint	m_block
	block size
Private Attributes inherited from OMQ::QueuedBlockConfigBase
*softint	m_queue_block_size = 2
	data queue block size; the number of blocks to queue for sending before the main data thread will block; default: 2
timeout	m_queue_timeout = 5m
	queue timeout; maximum amount of time a message can wait for the queue to become free; default: 5m
const	MinQueueBlockSize = 2
	minimum queue block size

Detailed Description

filesystem receive stream base config class

---

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

• Streams.qc