C# Class GSF.IO.MultipleDestinationExporter

Inheritance: System.ComponentModel.Component, ISupportLifecycle, ISupportInitialize, IProvideStatus, IPersistSettings
Afficher le fichier Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Свойство Type Description
BeginInit void
CopyFileToDestination void
DeleteTemporaryFile void
EndInit void
ExecuteExports void
InitializeExporter void
Shutdown void

Méthodes publiques

Méthode Description
ExportData ( byte fileData ) : void

Start multiple file export.

This is assumed to be the full content of the file to export. This class does not queue data since the export is not intended to append to an existing file but rather replace an existing one.

ExportData ( string fileData ) : void

Start multiple file export.

This is assumed to be the full content of the file to export. This class does not queue data since the export is not intended to append to an existing file but rather replace an existing one.

Initialize ( ) : void

Initializes (or reinitializes) MultipleDestinationExporter from configuration settings.

If not being used as a component (i.e., user creates their own instance of this class), this method must be called in order to initialize exports. Event if used as a component this method can be called at anytime to reinitialize the exports with new configuration information.

Initialize ( IEnumerable defaultDestinations ) : void

Initializes (or reinitializes) MultipleDestinationExporter from configuration settings.

If not being used as a component (i.e., user creates their own instance of this class), this method must be called in order to initialize exports. Even if used as a component this method can be called at anytime to reinitialize the exports with new configuration information.

LoadSettings ( ) : void

Loads saved settings for the MultipleDestinationExporter object from the config file if the PersistSettings property is set to true.

MultipleDestinationExporter ( ) : System

Initializes a new instance of the MultipleDestinationExporter class.

MultipleDestinationExporter ( IContainer container ) : System

Initializes a new instance of the MultipleDestinationExporter class.

MultipleDestinationExporter ( string settingsCategory, int exportTimeout ) : System

Initializes a new instance of the MultipleDestinationExporter class.

SaveSettings ( ) : void

Saves settings for the MultipleDestinationExporter object to the config file if the PersistSettings property is set to true.

Méthodes protégées

Méthode Description
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the MultipleDestinationExporter object and optionally releases the managed resources.

OnInitialized ( ) : void

Raises the Initialized event.

OnProcessException ( Exception ex ) : void

Raises ProcessException event.

OnStatusMessage ( string status ) : void

Raises the StatusMessage event.

Private Methods

Méthode Description
BeginInit ( ) : void
CopyFileToDestination ( object state ) : void
DeleteTemporaryFile ( string filename ) : void
EndInit ( ) : void
ExecuteExports ( ) : void
InitializeExporter ( object state ) : void
Shutdown ( ) : void

Method Details

Dispose() protected méthode

Releases the unmanaged resources used by the MultipleDestinationExporter object and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
Résultat void

ExportData() public méthode

Start multiple file export.
This is assumed to be the full content of the file to export. This class does not queue data since the export is not intended to append to an existing file but rather replace an existing one.
public ExportData ( byte fileData ) : void
fileData byte Binary data to export to each destination.
Résultat void

ExportData() public méthode

Start multiple file export.
This is assumed to be the full content of the file to export. This class does not queue data since the export is not intended to append to an existing file but rather replace an existing one.
public ExportData ( string fileData ) : void
fileData string Text based data to export to each destination.
Résultat void

Initialize() public méthode

Initializes (or reinitializes) MultipleDestinationExporter from configuration settings.
If not being used as a component (i.e., user creates their own instance of this class), this method must be called in order to initialize exports. Event if used as a component this method can be called at anytime to reinitialize the exports with new configuration information.
public Initialize ( ) : void
Résultat void

Initialize() public méthode

Initializes (or reinitializes) MultipleDestinationExporter from configuration settings.
If not being used as a component (i.e., user creates their own instance of this class), this method must be called in order to initialize exports. Even if used as a component this method can be called at anytime to reinitialize the exports with new configuration information.
public Initialize ( IEnumerable defaultDestinations ) : void
defaultDestinations IEnumerable Provides a default set of export destinations if none exist in configuration settings.
Résultat void

LoadSettings() public méthode

Loads saved settings for the MultipleDestinationExporter object from the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public LoadSettings ( ) : void
Résultat void

MultipleDestinationExporter() public méthode

Initializes a new instance of the MultipleDestinationExporter class.
public MultipleDestinationExporter ( ) : System
Résultat System

MultipleDestinationExporter() public méthode

Initializes a new instance of the MultipleDestinationExporter class.
public MultipleDestinationExporter ( IContainer container ) : System
container IContainer object that contains the .
Résultat System

MultipleDestinationExporter() public méthode

Initializes a new instance of the MultipleDestinationExporter class.
public MultipleDestinationExporter ( string settingsCategory, int exportTimeout ) : System
settingsCategory string The config file settings category under which the export destinations are defined.
exportTimeout int The total allowed time in milliseconds for each export to execute.
Résultat System

OnInitialized() protected méthode

Raises the Initialized event.
protected OnInitialized ( ) : void
Résultat void

OnProcessException() protected méthode

Raises ProcessException event.
protected OnProcessException ( Exception ex ) : void
ex System.Exception Processing .
Résultat void

OnStatusMessage() protected méthode

Raises the StatusMessage event.
protected OnStatusMessage ( string status ) : void
status string Status message to report.
Résultat void

SaveSettings() public méthode

Saves settings for the MultipleDestinationExporter object to the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public SaveSettings ( ) : void
Résultat void