Apama API Reference for .NET  9.10.0.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Apama.Services.Event.ChannelConfig Class Reference

ChannelConfig is a helper class that assists in building a properies map for use when creating a new EventServiceChannel via the IEventService.AddChannel() method. More...

Static Public Member Functions

static void SetDefaultRequestResponseTimeout (Dictionary< string, object > properties, long timeoutMs)
 Set the configuration property to indicate the default request-response timeout that a new EventServiceChannel should use. More...
 
static void SetEnforceResponseSequencing (Dictionary< string, object > properties, bool enforce)
 Set the configuration property to indicate if a new EventServiceChannel should use strict response sequencing for synchronous request-response invocations. More...
 
static void SetInboundEventQueueSoftReferencePrefixes (Dictionary< string, object > properties, ICollection< string > prefixes)
 Set the configuration property to indicate for which event names a new EventServiceChannel should use SoftReferences in the inbound queue. More...
 
static void SetMessageIdFieldName (Dictionary< string, object > properties, string fieldName)
 Set the configuration property to indicate the field name of message Id's (for request-response) that a new EventServiceChannel should use. More...
 

Detailed Description

ChannelConfig is a helper class that assists in building a properies map for use when creating a new EventServiceChannel via the IEventService.AddChannel() method.

Any configuration property not explicitly specified will take its default value. Defaults are available for all configuration properties, in the same interface as the property.

Member Function Documentation

static void Apama.Services.Event.ChannelConfig.SetDefaultRequestResponseTimeout ( Dictionary< string, object >  properties,
long  timeoutMs 
)
static

Set the configuration property to indicate the default request-response timeout that a new EventServiceChannel should use.

Parameters
propertiesThe Map in which the configuration properties should be updated.
timeoutMsThe new value of the property.
See also
EventServiceChannelConstants.ConfigRequestResponseTimeout
See also
EventServiceChannelConstants.DefaultRequestResponseTimeoutMs
static void Apama.Services.Event.ChannelConfig.SetEnforceResponseSequencing ( Dictionary< string, object >  properties,
bool  enforce 
)
static

Set the configuration property to indicate if a new EventServiceChannel should use strict response sequencing for synchronous request-response invocations.

Parameters
propertiesThe Map in which the configuration properties should be updated.
enforceThe new value of the property.
See also
EventServiceChannelConstants.ConfigEnforceResponseSequencing
See also
EventServiceChannelConstants.DefaultEnforceResponseSequencing
static void Apama.Services.Event.ChannelConfig.SetInboundEventQueueSoftReferencePrefixes ( Dictionary< string, object >  properties,
ICollection< string >  prefixes 
)
static

Set the configuration property to indicate for which event names a new EventServiceChannel should use SoftReferences in the inbound queue.

Parameters
propertiesThe Map in which the configuration properties should be updated.
prefixesThe new value of the property. Each value of the Set must be a String.
See also
EventServiceChannelConstants.ConfigInboundEventQueueSoftReferencePrefixes
See also
EventServiceChannelConstants.DefaultInboundEventQueueSoftReferencePrefixes
static void Apama.Services.Event.ChannelConfig.SetMessageIdFieldName ( Dictionary< string, object >  properties,
string  fieldName 
)
static

Set the configuration property to indicate the field name of message Id's (for request-response) that a new EventServiceChannel should use.

Parameters
propertiesThe Map in which the configuration properties should be updated.
fieldNameThe new value of the property.
See also
EventServiceChannelConstants.ConfigMessageIdFieldName
See also
EventServiceChannelConstants.DefaultMessageIdFieldName
Submit a bug or feature
Copyright (c) 2013-2016 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.