Qore FilePoller Module Reference 2.0
All Classes Namespaces Functions Variables Modules Pages
FilePoller::FilePollerDataProviderBase Class Reference

Event-based data provider for file events. More...

#include <FilePoller.qm.dox.h>

Inheritance diagram for FilePoller::FilePollerDataProviderBase:
[legend]

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

EmbeddedFilePoller poller
 The file poller itself.
 

Detailed Description

Event-based data provider for file events.

Note that this class will continue to output all matching files in the given folder until they are removed.

In the assumed scenario, matches files are removed by a single observer in the first notification event

Member Function Documentation

◆ getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > FilePoller::FilePollerDataProviderBase::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()

FilePoller::FilePollerDataProviderBase::updateConnectionObjects ( object  conn,
object  connobj 
)

Update any connection used by the data provider.

Parameters
connthe new AbstractConnection object
connobjthe new connection object itself (ex: RestClient for a "rest" connection)