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

#include <SftpPoller.qm.dox.h>

Inheritance diagram for SftpPoller::SftpDelayedPollerDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.

	observersReady ()
	Called when all observers have been added to the object.

	stopEvents ()
	Called to stop generating events.

Public Member Methods inherited from SftpPoller::SftpPollerDataProviderBase
	constructor (*hash< auto > options)
	Creates the object from constructor options.

*string	getDesc ()
	Returns the data provider description.

	updateConnectionObject (object conn)
	Update any connection used by the data provider.

Public Attributes
const	ProviderInfo = ...
	Provider info.

Public Attributes inherited from SftpPoller::SftpPollerDataProviderBase
const	ConstructorOptions = ...
	Constructor options.

Additional Inherited Members
Private Member Methods inherited from SftpPoller::SftpPollerDataProviderBase
hash< string, hash< DataProviderMessageInfo > >	getEventTypesImpl ()
	Returns a hash of all supported event types.

Private Attributes inherited from SftpPoller::SftpPollerDataProviderBase
EmbeddedSftpPoller	poller
	The file poller itself.

Detailed Description

Event-based data provider for SFTP polling events.

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

The event ID raised for SFTP file events is "ftp-file-event" (see EVENT_SFTP_FILE)

Member Function Documentation

SftpPoller::SftpDelayedPollerDataProvider::observersReady ( )

Called when all observers have been added to the object.

This method is meant to trigger event generation

SftpPoller::SftpDelayedPollerDataProvider::stopEvents ( )

Called to stop generating events.

Disconnects from the server and stops polling

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