Datafiles attached to FlowElements register with the dataFileUpdateService so the datafiles can receive automatic updates.
|
| | constructor (pipeline) |
| | Constructor for a DataFileUpdateService.
|
| | registerPipeline (pipeline) |
| | Method to register a pipeline with the update service.
|
| | on (listener, callback) |
| | EventEmitter's 'on' delegation.
|
| | once (listener, callback) |
| | EventEmitter's 'once' delegation.
|
| | updateDataFile (dataFile) |
| | Method that updates a datafile when it is due an update.
|
| | fileReady (dataFile, filename) |
| | Internal method called when the datafile has been downloaded and is ready after an update.
|
| | processFile (dataFile, filename) |
| | Internal method to process the datafile has been downloaded Including unzipping if needed.
|
| | checkNextUpdate (dataFile) |
| | Internal method to check the next update of a datafile at a polling interval set on the datafile.
|
| | registerDataFile (dataFile) |
| | Method that registers a datafile with the update service.
|
| DataFileUpdateService::checkNextUpdate |
( |
| dataFile | ) |
|
|
inline |
Internal method to check the next update of a datafile at a polling interval set on the datafile.
- Parameters
-
| {DataFile} | dataFile the datafile to check updates for |
| DataFileUpdateService::constructor |
( |
| pipeline | ) |
|
|
inline |
Constructor for a DataFileUpdateService.
- Parameters
-
| {Pipeline} | [pipeline] pipeline the update service is attached to |
@type {EventEmitter}
| DataFileUpdateService::fileReady |
( |
| dataFile, |
|
|
| filename ) |
|
inline |
Internal method called when the datafile has been downloaded and is ready after an update.
- Parameters
-
| {DataFile} | dataFile the datafile that is ready |
| {string} | filename the filename of the updated datafile |
- Returns
- {void}
| DataFileUpdateService::on |
( |
| listener, |
|
|
| callback ) |
|
inline |
EventEmitter's 'on' delegation.
- Parameters
-
| {string | | symbol} listener listener |
| {Function} | callback callback |
| DataFileUpdateService::once |
( |
| listener, |
|
|
| callback ) |
|
inline |
EventEmitter's 'once' delegation.
- Parameters
-
| {string | | symbol} listener listener |
| {Function} | callback callback |
| DataFileUpdateService::processFile |
( |
| dataFile, |
|
|
| filename ) |
|
inline |
Internal method to process the datafile has been downloaded Including unzipping if needed.
- Parameters
-
| {DataFile} | dataFile the datafile to processs |
| {string} | filename the filename of the downloaded data |
| DataFileUpdateService::registerDataFile |
( |
| dataFile | ) |
|
|
inline |
Method that registers a datafile with the update service.
- Parameters
-
| {DataFile} | dataFile the datafile to register |
| DataFileUpdateService::registerPipeline |
( |
| pipeline | ) |
|
|
inline |
Method to register a pipeline with the update service.
- Parameters
-
| {Pipeline} | [pipeline] Pipeline to register |
| DataFileUpdateService::updateDataFile |
( |
| dataFile | ) |
|
|
inline |
Method that updates a datafile when it is due an update.
- Parameters
-
| {DataFile} | dataFile the datafile to update |
- Returns
- {boolean | void} returns false if already updating or request failed
