Constants used by the Scenario Service. More...

Public Attributes
const string	ConfigAckDataTimeout = "ackDataTimeout"
	Configuration property name specifying the the timeout between receiving an Acknowledge for an operation (Create, Edit, Delete) and seeing the response (Created, Edited, Delted) on the Data channel. More...

const string	ConfigOverrideAckDataTimeout = "overrideAckDataTimeout"
	Configuration property name specifying the the timeout between receiving an Acknowledge for an operation (Create, Edit, Delete) and seeing the response (Created, Edited, Delted) on the Data channel. More...

const string	ConfigScenarioExclusionFilter = "scenarioExclusionFilter"
	Configuration property name for specifying a Set of ScenarioID's (Strings) that the client wishes to exclude. More...

const string	ConfigScenarioInclusionFilter = "scenarioInclusionFilter"
	Configuration property name for specifying a Set of ScenarioID's (Strings) in which the client is interested. More...

const string	ConfigStrongDataInboundEventQueue = "strongDataInboundEventQueue"
	Configuration property name for specifying if the EventServiceChannels created for listening to ScenarioInstance updates (the 'Data' channel) should use strong or soft references to events in the inbound queue. More...

const string	ConfigUseRawDataChannel = "useRawDataChannel"
	Configuration property name for specifying if the EventServiceChannels created for listening to ScenarioInstance updates (the 'Data' channel) should be subscribed to the normal Data channel (possibly throttled), or the Raw Data channel (always unthrottled). More...

const long	DefaultAckDataTimeout = 60000
	Default value for the configuration property that specifies the timeout for waiting for an operation response after the acknowledge (60000ms). More...

const bool	DefaultStrongDataInboundEventQueue = true
	Default value for the boolean flag specifying if the inbound event queues for 'Data' channels will use strong references (true). More...

const bool	DefaultUseRawDataChannel = false
	Default value for the boolean flag specifying if the 'Data' channel to subscribe to for a scenario will be the normal (possibly throttled) channel, or the 'Raw' (always unthrottled) channel (false). More...

const string	PropertyScenarioAdded = "Apama.Services.Scenario.IScenarioService.ScenarioAdded"
	Property name for events fired that signal a new ScenarioDefinition has been added. More...

const string	PropertyScenarioDiscoveryStatus = "Apama.Services.Scenario.IScenarioService.ScenarioDiscoveryStatus"
	Property name for events fired that signal the status of the internal mechanism for discovering scenario definitions in the Correlator. More...

const string	PropertyScenarioRemoved = "Apama.Services.Scenario.IScenarioService.ScenarioRemoved"
	Property name for events fired that signal an existing ScenarioDefinition has been removed. More...

const string	PropertyScenarioServiceUnloaded = "Apama.Services.Scenario.IScenarioService.ScenarioServiceUnloaded"
	Property name for events fired that signal the ScenarioService has been unloaded. More...

Static Public Attributes
static readonly string	ConfigAutoInstanceDiscovery = "autoRequestInstances"
	Configuration property name specifying whether to automatically initiate discovery of all scenario instances upon creating a scenario service. More...

static readonly string	ConfigDisconnectIfSlow = "slowDisconnect"
	Configuration property name specifying whether to connect to the data source signalling that we may be disconnected if we do not keep up with events. More...

static readonly string	ConfigFilterUser = "filterUser"
	Configuration property name specifying whether to only list to updates for the specified user More...

static readonly string	ConfigReconnectPeriod = "reconnectPeriod"
	Configuration property name specifying how long to wait between attempts to reconnect to the correlator More...

static readonly bool	DefaultAutoInstanceDiscovery = true
	Default value for automatic instance discovery (true) More...

static readonly bool	DefaultDisconnectIfSlow = false
	Default value for the boolean flag specifying if we should be disconnected if slow (false) More...

static readonly long	DefaultReconnectPeriod = 0
	Default value for the long specifying how long to wait between reconnects More...

static readonly ICollection < string >	DefaultScenarioExclusionFilter = null
	Default value for the configuration property that specifies the optional scenario exclusion filter set (null). More...

static readonly ICollection < string >	DefaultScenarioInclusionFilter = null
	Default value for the configuration property that specifies the optional scenario inclusion filter set (null). More...

static readonly string	PropDefaultAckDataTimeout
	System property (in millisecond) to set the default AckData Timeout. If this property is defined, then its value will be used instead of the hard-coded DefaultAckDataTimeout More...

static readonly string	PropFilterUser = "Apama.Scenario.FilterUser"
	system property specifying whether to only list to updates for the specified user More...

static readonly string	PropOverrideAckDataTimeout
	System property (in millisecond) to override AckData Timeout. More...

Detailed Description

Constants used by the Scenario Service.

Member Data Documentation

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigAckDataTimeout = "ackDataTimeout"

Configuration property name specifying the the timeout between receiving an Acknowledge for an operation (Create, Edit, Delete) and seeing the response (Created, Edited, Delted) on the Data channel.

This determines how skewed the Data and Control channels have to be for an operation to fail.

See also: DefaultAckDataTimeout

readonly string Apama.Services.Scenario.ScenarioServiceConstants.ConfigAutoInstanceDiscovery = "autoRequestInstances"

static

Configuration property name specifying whether to automatically initiate discovery of all scenario instances upon creating a scenario service.

readonly string Apama.Services.Scenario.ScenarioServiceConstants.ConfigDisconnectIfSlow = "slowDisconnect"

static

Configuration property name specifying whether to connect to the data source signalling that we may be disconnected if we do not keep up with events.

Only the first connection's disconnectSlow property is respected; further connections to a component will re-use an existing connection's policy.

readonly string Apama.Services.Scenario.ScenarioServiceConstants.ConfigFilterUser = "filterUser"

static

Configuration property name specifying whether to only list to updates for the specified user

If present, the scenario(s) listened for must have the ConfigureUpdates property sendRawUser or sendThrottledUser set to true.

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigOverrideAckDataTimeout = "overrideAckDataTimeout"

Configuration property name specifying the the timeout between receiving an Acknowledge for an operation (Create, Edit, Delete) and seeing the response (Created, Edited, Delted) on the Data channel.

This overrides ConfigAckDataTimeout

This determines how skewed the Data and Control channels have to be for an operation to fail.

readonly string Apama.Services.Scenario.ScenarioServiceConstants.ConfigReconnectPeriod = "reconnectPeriod"

static

Configuration property name specifying how long to wait between attempts to reconnect to the correlator

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigScenarioExclusionFilter = "scenarioExclusionFilter"

Configuration property name for specifying a Set of ScenarioID's (Strings) that the client wishes to exclude.

If the Set is null or empty, then the scenarios are unfiltered, and the service will register an interest in all scenarios. If the Set contains any items, then the service will ignore all scenarios in the Set.

Note: If the ConfigScenarioInclusionFilter is non-null then this exclusion filter will be entirely ignored.

See also: DefaultScenarioExclusionFilter

See also: DefaultScenarioInclusionFilter

See also: ConfigScenarioInclusionFilter

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigScenarioInclusionFilter = "scenarioInclusionFilter"

Configuration property name for specifying a Set of ScenarioID's (Strings) in which the client is interested.

If the Set is null or empty, then the scenarios are unfiltered, and the service will register an interest in all scenarios. If the Set contains any items, then the service will ignore all scenarios except those in the Set.

Note: If this property is non-null then the exclusion filter (ConfigScenarioExclusionFilter) will be entirely ignored.

See also: DefaultScenarioInclusionFilter

See also: DefaultScenarioExclusionFilter

See also: ConfigScenarioExclusionFilter

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigStrongDataInboundEventQueue = "strongDataInboundEventQueue"

Configuration property name for specifying if the EventServiceChannels created for listening to ScenarioInstance updates (the 'Data' channel) should use strong or soft references to events in the inbound queue.

This property will (for 'Data' channels only) override any value set for the property Apama.Services.Event.EventServiceChannelConstants.ConfigInboundEventQueueSoftReferencePrefixes}.

See also: DefaultStrongDataInboundEventQueue

const string Apama.Services.Scenario.ScenarioServiceConstants.ConfigUseRawDataChannel = "useRawDataChannel"

Configuration property name for specifying if the EventServiceChannels created for listening to ScenarioInstance updates (the 'Data' channel) should be subscribed to the normal Data channel (possibly throttled), or the Raw Data channel (always unthrottled).

See also: DefaultUseRawDataChannel

const long Apama.Services.Scenario.ScenarioServiceConstants.DefaultAckDataTimeout = 60000

Default value for the configuration property that specifies the timeout for waiting for an operation response after the acknowledge (60000ms).

This determines how skewed the Data and Control channels have to be for an operation to fail.

readonly bool Apama.Services.Scenario.ScenarioServiceConstants.DefaultAutoInstanceDiscovery = true

static

Default value for automatic instance discovery (true)

readonly bool Apama.Services.Scenario.ScenarioServiceConstants.DefaultDisconnectIfSlow = false

static

Default value for the boolean flag specifying if we should be disconnected if slow (false)

readonly long Apama.Services.Scenario.ScenarioServiceConstants.DefaultReconnectPeriod = 0

static

Default value for the long specifying how long to wait between reconnects

readonly ICollection<string> Apama.Services.Scenario.ScenarioServiceConstants.DefaultScenarioExclusionFilter = null

static

Default value for the configuration property that specifies the optional scenario exclusion filter set (null).

readonly ICollection<string> Apama.Services.Scenario.ScenarioServiceConstants.DefaultScenarioInclusionFilter = null

static

Default value for the configuration property that specifies the optional scenario inclusion filter set (null).

const bool Apama.Services.Scenario.ScenarioServiceConstants.DefaultStrongDataInboundEventQueue = true

Default value for the boolean flag specifying if the inbound event queues for 'Data' channels will use strong references (true).

const bool Apama.Services.Scenario.ScenarioServiceConstants.DefaultUseRawDataChannel = false

Default value for the boolean flag specifying if the 'Data' channel to subscribe to for a scenario will be the normal (possibly throttled) channel, or the 'Raw' (always unthrottled) channel (false).

readonly string Apama.Services.Scenario.ScenarioServiceConstants.PropDefaultAckDataTimeout

static

Initial value:

=

typeof(IScenarioService).FullName + ".DEFAULT_ACKDATA_TIMEOUT"

System property (in millisecond) to set the default AckData Timeout. If this property is defined, then its value will be used instead of the hard-coded DefaultAckDataTimeout

See also: DefaultAckDataTimeout, PropOverrideAckDataTimeout

const string Apama.Services.Scenario.ScenarioServiceConstants.PropertyScenarioAdded = "Apama.Services.Scenario.IScenarioService.ScenarioAdded"

Property name for events fired that signal a new ScenarioDefinition has been added.

const string Apama.Services.Scenario.ScenarioServiceConstants.PropertyScenarioDiscoveryStatus = "Apama.Services.Scenario.IScenarioService.ScenarioDiscoveryStatus"

Property name for events fired that signal the status of the internal mechanism for discovering scenario definitions in the Correlator.

See also: Apama.Services.Scenario.DiscoveryStatus

const string Apama.Services.Scenario.ScenarioServiceConstants.PropertyScenarioRemoved = "Apama.Services.Scenario.IScenarioService.ScenarioRemoved"

Property name for events fired that signal an existing ScenarioDefinition has been removed.

const string Apama.Services.Scenario.ScenarioServiceConstants.PropertyScenarioServiceUnloaded = "Apama.Services.Scenario.IScenarioService.ScenarioServiceUnloaded"

Property name for events fired that signal the ScenarioService has been unloaded.

readonly string Apama.Services.Scenario.ScenarioServiceConstants.PropFilterUser = "Apama.Scenario.FilterUser"

static

system property specifying whether to only list to updates for the specified user

If present, the scenario(s) listened for must have the ConfigureUpdates property sendRawUser or sendThrottledUser set to true.

readonly string Apama.Services.Scenario.ScenarioServiceConstants.PropOverrideAckDataTimeout

static

Initial value:

=

typeof(IScenarioService).FullName + ".OVERRIDE_ACKDATA_TIMEOUT"

System property (in millisecond) to override AckData Timeout.

If this property is defined, then its value will be used at runtime. This value will supersede the ConfigAckDataTimeout and PropDefaultAckDataTimeout_MS property setting.

See also: DefaultAckDataTimeout, ConfigAckDataTimeout, PropDefaultAckDataTimeout

Public Attributes

Static Public Attributes

Detailed Description

Member Data Documentation