Qore ssh2 Module ..
Loading...
Searching...
No Matches
SftpPoller::SftpPollerDataProviderBase Class Reference

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

#include <SftpPoller.qm.dox.h>

Inheritance diagram for SftpPoller::SftpPollerDataProviderBase:
SftpPoller::SftpDelayedPollerDataProvider SftpPoller::SftpPollerDataProvider

Public Member Methods

 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 ConstructorOptions = ...
 Constructor options.
 

Private Member Methods

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

Private Attributes

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

Member Function Documentation

◆ getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > SftpPoller::SftpPollerDataProviderBase::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

◆ updateConnectionObject()

SftpPoller::SftpPollerDataProviderBase::updateConnectionObject ( object  conn)

Update any connection used by the data provider.

Parameters
connthe new connection object

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