Apac.Configuration.HttpControllerConfig Class Reference

Configuration for the Control.HttpController. More...

Inheritance diagram for Apac.Configuration.HttpControllerConfig:

Static Public Attributes
const string	TargetsElement = "targets"
const string	TargetElement = "target"

Protected Member Functions
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
Protected Member Functions inherited from Apac.Configuration.SupervisableConfig
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...

Properties
HttpTargetConfig[]	Targets [get]
Properties inherited from Apac.Configuration.ControllerConfig
string	CompilerRef [get, set]
	Gets or sets teh name of the supervisable component responsible for compiling the data gathered by the controller. More...
ushort	InputResolutionBits [get, set]
	Gets or sets the number of bits of resolution provided by the input registers of the device being controlled. Default value is 10 bits. More...
ushort	FrequencySeconds [get, set]
	Gets or sets the polling frequency in seconds. More...
ushort	DelayMilliseconds [get, set]
	Gets or sets the polling delay in milliseconds. This is the amount of time the thread sleeps before it checks its schedule again. Setting this to a higher number limits context switches, but decreases the resolution at which the schedule will be kept (ie: it is more likely to over-shoot the schedule if this is a big number). A lower number makes it more likely to hit the schedule accurately, but is also more CPU-intense. This is a variable so large polling frequencies, like 300, can be used and at the same time a better pause interval can be set so the poller is as efficient as possible, without constantly grinding to check if the scheduled time has arrived. More...
Properties inherited from Apac.Configuration.SupervisableConfig
string	TypeName [get, set]
	Gets or sets the name of the type of the supervisable component. More...
string	TypeForConfig [get, set]
	Gets or sets the type for the SupervisableConfig. More...
bool	Prioritized [get, set]
	Gets or sets a value indicating whether the Apac.ISupervisable is prioritized. More...
ReferenceConfigCollection	References [get]
	Gets the references. More...
Properties inherited from Apac.Configuration.ConfigElement
virtual bool	IsValid [get]
	Gives a way for subclasses to determine validity. More...
string	Name [get, set]
	Gets or sets the name property setting. More...
string	Description [get, set]
	Gets or sets the description property setting. More...
bool	Enabled [get, set]
	Gets or sets a value indicating whether this ConfigElement is enabled. More...
log4net.ILog	Log [get]
	Provides a log4net.ILog instance for use by the whole class hierarchy. More...

Additional Inherited Members
Public Member Functions inherited from Apac.Configuration.ControllerConfig
	ControllerConfig (string dataCompilerRef, ushort inputResolutionBits, ushort freqSeconds, ushort delayMilliseconds, string name, string configType, string type, string description, bool prioritized)
Public Member Functions inherited from Apac.Configuration.SupervisableConfig
	SupervisableConfig ()
	Initializes a new instance of the SupervisableConfig class. More...
	SupervisableConfig (string name, string configType, string type, string description, bool prioritized)
	Initializes a new instance of the SupervisableConfig class. More...
Public Member Functions inherited from Apac.Configuration.ConfigElement
	ConfigElement ()
	Initializes a new instance of the ConfigElement class. More...
	ConfigElement (string name, string description, bool enabled)
	Initializes a new instance of the ConfigElement class. More...
override int	GetHashCode ()
	Returns a hash code for this instance. More...
override bool	Equals (object compareTo)
	Determines whether the specified System.Object is equal to this instance. More...
System.Xml.Schema.XmlSchema	GetSchema ()
	This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class. More...
void	ReadXml (System.Xml.XmlReader reader)
	Generates an object from its XML representation. More...
void	WriteXml (System.Xml.XmlWriter writer)
	Converts an object into its XML representation. More...

Detailed Description

Configuration for the Control.HttpController.

See also

Apac.Configuration.ControllerConfig

This class is currently written to only support a polling controller, but needs to be updated to allow for a listening controller too, which will entail establishing a listener base url, and so on.

Member Function Documentation

OnReadXml()

override void Apac.Configuration.HttpControllerConfig.OnReadXml ( System.Xml.XmlReader  reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader

The reader.

Reimplemented from Apac.Configuration.ControllerConfig.

OnWriteXml()

override void Apac.Configuration.HttpControllerConfig.OnWriteXml ( System.Xml.XmlWriter  writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer

The writer.

Reimplemented from Apac.Configuration.ControllerConfig.

---

The documentation for this class was generated from the following file:

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/HttpControllerConfig.cs