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

A subscribing Agent that runs based upon settings from a pre-defined SIFWorks ADK configuration file.
Inheritance: Systemic.Sif.Framework.Agent.BaseAgent, ISubscribingAgent
Exibir arquivo Open project: nsip/SifCommonFramework-dotNet

Public Methods

Method Description
GetSubscribers ( ) : IList

This method returns the Subscribers used by this Agent.
Run ( ) : void

This method will run the SIF Agent and Unsubscribe on shut down. Only the first call to this method will be recognised; subsequent calls will be ignored.
SubscribingAgent ( ) : System

This constructor will create a subscribing Agent using the default "agent.cfg" file. If this configuration file does not exist, the Agent will not run when called.
SubscribingAgent ( String cfgFileName ) : System

This constructor defines the configuration file associated with this Agent.

Protected Methods

Method Description
StartAgent ( ) : void

Connect to the Zones and configure the Subscribers.

Method Details

GetSubscribers() public method

This method returns the Subscribers used by this Agent.
public GetSubscribers ( ) : IList
return IList

Run() public method

This method will run the SIF Agent and Unsubscribe 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 Subscribers.
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 Subscriber.
protected StartAgent ( ) : void
return void

SubscribingAgent() public method

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

SubscribingAgent() public method

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