Implements a custom configuration section for defining the behavior of the MessageController class. More...

Inheritance diagram for Apac.Configuration.MessageControllerConfigSection:

Static Public Member Functions
static MessageControllerConfigSection	GetSection ()
	Gets the section from the config file with the name specified in the appSetting key named MessageControllerSectionSettingName, or default name if that key is not defined or is empty. More...

static MessageControllerConfigSection	GetSection (string name)
	Gets the named section from the config file. More...

Static Public Attributes
static readonly string	DefaultConfigSectionName = "apac.messaging"
	The default name for the messaging configuration section. More...

static readonly string	MessageControllerSectionSettingName = "apac.messaging.section"
	A constant value used to denote the name of the AppSettings key that can be used to redirect this class to a configuration section by a name other than the default name (see DefaultConfigSectionName). More...

Properties
string	RootPath `[get, set]`
	Gets or sets the directory path to be used as the root of the messaging queue. This path will be further subdivided into the configured queues. More...

bool	UseXml `[get, set]`
	Gets or sets the switch to use XML or binary serialization when enqueuing messages. More...

QueueConfigElements	Queues `[get, set]`
	Gets or sets the queues defined in this message controller configuration section. More...

ProtocolConfigElements	Protocols `[get, set]`
	Gets or sets the protocols defined in this message controller configuration section. More...

uint	RetryInterval `[get, set]`
	Gets or sets the retry interval for failed messages (in seconds). The defaule value is 60 seconds, but higher values may be more appropriate. More...

uint	RetryCount `[get, set]`
	Gets or sets the retry count for failed messages. The default value is 0 (infinite), but higher values may be more appropriate. This value applies per protocol, so if a message type is configured to be sent over more than one protocol, each one would have to fail this many times before the message would be considered in error. More...

uint	ArchiveDays `[get, set]`
	Gets or sets the number of days worth of messages to keep in the archive for each queue. The defaule value is 30. More...

string	WellknownSystemQueue `[get, set]`
	Gets or sets the well-known name of the queue used for system status messages. The default value is 'system', so any messaging setup must include provisions for handling this well-known queue name or the alternate name specified by configuration. More...

string	WellknownConfigQueue `[get, set]`
	Gets or sets the well-known name of the queue used for system configuration messages. The default value is 'config', so any messaging setup must include provisions for handling this well-known queue name or the alternate name specified by configuration. More...

AddressResolverConfigElements	AddressResolvers `[get, set]`
	Gets or sets the address resolvers used when MessagingAddressRefElements or MessagingGroupRefElements are used for sender and/or recipient addresses. More...

MessagingAddressElements	Addresses `[get, set]`
	Gets or sets the address declarations for the configuration. These can define the addresses which can later be referenced from the various parts of the queues element as senders and recipients using 'senderRef' and 'recipientRef' elements. More...

MessagingGroupElements	AddressGroups `[get, set]`
	Gets or sets the address groups. More...

Dictionary< int, string >	MessagingProtocols `[get]`
	Gets the messaging protocols coded into the system. See Messaging.MessagingProtocols More...

Detailed Description

Implements a custom configuration section for defining the behavior of the MessageController class.

Member Function Documentation

◆ GetSection() [1/2]

static MessageControllerConfigSection Apac.Configuration.MessageControllerConfigSection.GetSection ( )

inlinestatic

Gets the section from the config file with the name specified in the appSetting key named MessageControllerSectionSettingName, or default name if that key is not defined or is empty.

Returns: The MessageControllerConfigSection having the default name (see DefaultConfigSectionName.

◆ GetSection() [2/2]

static MessageControllerConfigSection Apac.Configuration.MessageControllerConfigSection.GetSection ( string name )

inlinestatic

Gets the named section from the config file.

Parameters

name	The name of the section to be retrieved.

Returns: The MessageControllerConfigSection having the name of name .

Member Data Documentation

◆ DefaultConfigSectionName

readonly string Apac.Configuration.MessageControllerConfigSection.DefaultConfigSectionName = "apac.messaging"

static

The default name for the messaging configuration section.

◆ MessageControllerSectionSettingName

readonly string Apac.Configuration.MessageControllerConfigSection.MessageControllerSectionSettingName = "apac.messaging.section"

static

A constant value used to denote the name of the AppSettings key that can be used to redirect this class to a configuration section by a name other than the default name (see DefaultConfigSectionName).

Property Documentation

◆ Addresses

MessagingAddressElements Apac.Configuration.MessageControllerConfigSection.Addresses

getset

Gets or sets the address declarations for the configuration. These can define the addresses which can later be referenced from the various parts of the queues element as senders and recipients using 'senderRef' and 'recipientRef' elements.

The addresses.

◆ AddressGroups

MessagingGroupElements Apac.Configuration.MessageControllerConfigSection.AddressGroups

getset

Gets or sets the address groups.

The address groups.

◆ AddressResolvers

AddressResolverConfigElements Apac.Configuration.MessageControllerConfigSection.AddressResolvers

getset

Gets or sets the address resolvers used when MessagingAddressRefElements or MessagingGroupRefElements are used for sender and/or recipient addresses.

The address resolvers.

◆ ArchiveDays

uint Apac.Configuration.MessageControllerConfigSection.ArchiveDays

getset

Gets or sets the number of days worth of messages to keep in the archive for each queue. The defaule value is 30.

◆ MessagingProtocols

Dictionary<int, string> Apac.Configuration.MessageControllerConfigSection.MessagingProtocols

get

Gets the messaging protocols coded into the system. See Messaging.MessagingProtocols

The messaging protocols.

◆ Protocols

ProtocolConfigElements Apac.Configuration.MessageControllerConfigSection.Protocols

getset

Gets or sets the protocols defined in this message controller configuration section.

◆ Queues

QueueConfigElements Apac.Configuration.MessageControllerConfigSection.Queues

getset

Gets or sets the queues defined in this message controller configuration section.

◆ RetryCount

uint Apac.Configuration.MessageControllerConfigSection.RetryCount

getset

Gets or sets the retry count for failed messages. The default value is 0 (infinite), but higher values may be more appropriate. This value applies per protocol, so if a message type is configured to be sent over more than one protocol, each one would have to fail this many times before the message would be considered in error.

◆ RetryInterval

uint Apac.Configuration.MessageControllerConfigSection.RetryInterval

getset

Gets or sets the retry interval for failed messages (in seconds). The defaule value is 60 seconds, but higher values may be more appropriate.

◆ RootPath

string Apac.Configuration.MessageControllerConfigSection.RootPath

getset

Gets or sets the directory path to be used as the root of the messaging queue. This path will be further subdivided into the configured queues.

◆ UseXml

bool Apac.Configuration.MessageControllerConfigSection.UseXml

getset

Gets or sets the switch to use XML or binary serialization when enqueuing messages.

◆ WellknownConfigQueue

string Apac.Configuration.MessageControllerConfigSection.WellknownConfigQueue

getset

Gets or sets the well-known name of the queue used for system configuration messages. The default value is 'config', so any messaging setup must include provisions for handling this well-known queue name or the alternate name specified by configuration.

◆ WellknownSystemQueue

string Apac.Configuration.MessageControllerConfigSection.WellknownSystemQueue

getset

Gets or sets the well-known name of the queue used for system status messages. The default value is 'system', so any messaging setup must include provisions for handling this well-known queue name or the alternate name specified by configuration.

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

/var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/MessageControllerConfigSection.cs

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ GetSection() [1/2]

◆ GetSection() [2/2]

Member Data Documentation

◆ DefaultConfigSectionName

◆ MessageControllerSectionSettingName

Property Documentation

◆ Addresses

◆ AddressGroups

◆ AddressResolvers

◆ ArchiveDays

◆ MessagingProtocols

◆ Protocols

◆ Queues

◆ RetryCount

◆ RetryInterval

◆ RootPath

◆ UseXml

◆ WellknownConfigQueue

◆ WellknownSystemQueue