C# Class Systemic.Sif.Framework.Agent.PublishingAgent

A publishing Agent that runs based upon settings from a pre-defined SIFWorks ADK configuration file.
Inheritance: Systemic.Sif.Framework.Agent.BaseAgent, IPublishingAgent
Datei anzeigen Open project: nsip/SifCommonFramework-dotNet

Public Methods

Method Description
GetPublishers ( ) : IList

This method returns the Publishers used by this Agent.

PublishingAgent ( ) : System

This constructor will create a publishing Agent using the default "agent.cfg" file. If this configuration file does not exist, the Agent will not run when called.

PublishingAgent ( String cfgFileName ) : System

This constructor defines the configuration file associated with this Agent.

Run ( ) : void

This method will run the SIF Agent and Unprovide on shut down. Only the first call to this method will be recognised; subsequent calls will be ignored.

Protected Methods

Method Description
StartAgent ( ) : void

Connect to the Zones and configure the Publisher.

Method Details

GetPublishers() public method

This method returns the Publishers used by this Agent.
public GetPublishers ( ) : IList
return IList

PublishingAgent() public method

This constructor will create a publishing Agent using the default "agent.cfg" file. If this configuration file does not exist, the Agent will not run when called.
public PublishingAgent ( ) : System
return System

PublishingAgent() public method

This constructor defines the configuration file associated with this Agent.
public PublishingAgent ( String cfgFileName ) : System
cfgFileName String Configuration file associated with this Agent. If not provided, assumes "agent.cfg".
return System

Run() public method

This method will run the SIF Agent and Unprovide on shut down. Only the first call to this method will be recognised; subsequent calls will be ignored.
public Run ( ) : void
return void

StartAgent() protected method

Connect to the Zones and configure the Publisher.
The Agent has not been initialised first. The Agent was unable to connect to a Zone, or there is an error with the event processing for a Publisher.
protected StartAgent ( ) : void
return void