FtpPoller::FtpPollerDataProviderBase Class Reference

Event-based data provider for FTP polling events. More...

#include <FtpPoller.qm.dox.h>

Inheritance diagram for FtpPoller::FtpPollerDataProviderBase:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.
*string	getDesc ()
	Returns the data provider description.
	updateConnectionObjects (object conn, object connobj)
	Update any connection used by the data provider.

Public Attributes
const	ConstructorOptions = ...
	Constructor options.

Private Member Methods
hash< string, hash< DataProviderMessageInfo > >	getEventTypesImpl ()
	Returns a hash of all supported event types.

Private Attributes
EmbeddedFtpPoller	poller
	The file poller itself.

Detailed Description

Event-based data provider for FTP polling events.

When using the local_dir option, the local file must be removed / moved / archived by the event handler

Member Function Documentation

getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > FtpPoller::FtpPollerDataProviderBase::getEventTypesImpl ( )

private

Returns a hash of all supported event types.

Returns

a hash of all supported event types

Note

only called if the provider supports the observer pattern / event API

updateConnectionObjects()

FtpPoller::FtpPollerDataProviderBase::updateConnectionObjects	(	object	conn,
		object	connobj
	)

Update any connection used by the data provider.

Parameters

conn	the new AbstractConnection object
connobj	the new connection object itself (ex: RestClient for a "rest" connection)