Apama API Reference for .NET  10.5.4.1
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12345]
 NApama
 NEngine
 NClient
 CConsumerOperationsConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CCorrelatorManagementConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CEngineClientConstantsA static class containing constants used by the engine client interfaces
 CEngineClientFactoryEngineClientFactory is a factory for classes that implement Apama messaging or correlator management interfaces
 CIConnectOperationsIConnectOperations is an interface that specifies methods for connecting an engine as a consumer of another engine
 CIConsumerOperationsIConsumerOperations is an interface that specifies the standard operations to enable a client to receive events on specific channels from a remote Correlator
 CICorrelatorManagementICorrelatorManagement is the interface for all management operations that can be performed on an Apama Correlator
 CIEngineClientProvides a convenient interface for interacting with an Apama engine, typically a Correlator. This includes the ability to send and receive events, inject and delete EPL/MonitorScript, connect Apama engines together, inspect what was injected into correlator and more
 CIMessagingClientThis interface is for all operations that can be performed on an Apama component related to sending and receiving messages (e.g. events, injections, deletions, etc)
 CIReconnectPolicyIReconnectPolicy is a policy that can be set on an EngineClient object which controls when it should reconnect
 CMessagingClientConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CApiThe Api class contains static methods to initialise and stop the client interface
 CEngineConnectionEngineConnection encapsulates the information related to a connection between two Apama messaging components
 CEngineInfoThis class provides access to all of the information returned from an engine as a result of a call to the InspectEngine() method
 CEngineManagementThe EngineManagement interface is the primary low-level interface to the Engine, and allows operations to be carried out on it
 CEngineStatusEngineStatus represents the operational status of a correlator
 CMonitorScriptA MonitorScript object encapsulates a MonitorScript code fragment, containing package, event and monitor definitions to be injected into an Engine
 CNamedAggregateInfoThis class provides access to a snapshot of information about an aggregate that is/was live in the engine
 CNamedContextInfoThis class provides access to a snapshot of information about a Context that is/was live in the engine
 CNamedEventTypeInfoThis class provides access to a snapshot of information about a Monitor that is/was live in the engine
 CNamedJavaApplicationInfoThis class provides access to a snapshot of information about a Java (JMon) Application that is/was live in the engine
 CNamedMonitorInfoThis class provides access to a snapshot of information about a Monitor that is/was live in the engine
 CNamedPluginReceiverInfoThis class provides access to a snapshot of information about a PluginReceiver that is/was connected to the engine
 CNamedReceiverInfoThis class provides access to a snapshot of information about a Receiver that is/was connected to the engine
 CNamedTimerInfoThis class provides access to a snapshot of information about a Timer that is/was live in the engine
 CNameInfoThis is the base class for a named object (i.e. event type, container type or monitor) returned by an engine inspection. Returned by methods of the EngineInfo class
 NEvent
 NParser
 CAnyFieldTypeRepresents the Apama any type, for which values are specified as AnyFieldValue objects
 CAnyFieldValueRepresents the value of an Apama any field
 CBooleanFieldTypeRepresents the Apama boolean type, for which values are specified as Boolean objects
 CChannelFieldTypeRepresents the Apama Channel type, for which values are specified as String objects
 CContextFieldTypeRepresents the Apama context type, for which values are specified as String objects
 CDecimalFieldTypeRepresents the Apama decimal type, for which values are specified as DecimalFieldValue objects
 CDecimalFieldValueRepresents the value of an Apama decimal field, using Decimal or Double objects
 CDictionaryFieldTypeGeneric class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.Generic.IDictionary<K,V> objects
 CEventParserProvides the functionality to parse System.String objects into Apama Apama.Event.Event objects, for
 CEventTypeRepresents the definition of an Apama event type, for which values are specified as Apama.Event.Event objects. Each EventType consists of an event type name, and zero or more Field<T> objects. An event that contains an 'any' field must be registered to exactly one EventParser object, along with all types that may be contained within the 'any' value. Example: EVENT_PARSER.RegisterType(FieldTypes.Sequence(FieldTypes.Integer));
 CFieldRepresents the name and type of a field in an EventType
 CFieldTypeRepresents an Apama type. Used to define the type of fields in an EventType, and also for type parameters in complex types such as FieldTypes.Sequence<T>(FieldType<T>). Get field type objects using FieldTypes
 CFieldTypesProvides factory methods and constants for getting all supported Apama event field types
 CFloatFieldTypeRepresents the Apama float type, for which values are specified as Double objects
 CIntegerFieldTypeRepresents the Apama integer type, for which values are specified as Int64 objects
 CLocationFieldTypeRepresents the Apama location type, for which values are specified as LocationType objects
 CLocationTypeRepresents the value of an Apama location type, consisting of of two (x,y) co-ordinates
 COptionalFieldTypeRepresents the Apama optional type, for which the contained types are specified as either PrimitiveFieldType<T> or ReferenceFieldType<T> objects
 CParserRuntimeExceptionParserRuntimeException will be thrown when an error occurs while parsing an Apama event
 CPrimitiveFieldTypeAbstract class for Apama types which will be represented by primitive types in C# (E.g. Integer, Boolean and Float). Used to define the type of fields in an EventType, and also for type parameters in complex types such as FieldTypes.Sequence<T>(FieldType<T>). Get field type objects using FieldTypes
 CReferenceFieldTypeAbstract class for Apama types which will be represented by reference types in C# (E.g. Sequence, Dictionary Event, Decimal etc). Used to define the type of fields in an EventType, and also for type parameters in complex types such as FieldTypes.Sequence<T>(FieldType<T>). Get field type objects using FieldTypes
 CSequenceFieldTypeGeneric class that represents the Apama sequence<type> type, for which values are specified as System.Collections.Generic.IList<E> objects
 CStringFieldTypeRepresents the Apama string type, for which values are specified as String objects
 CDisconnectableEventConsumerThis class extends EventConsumer and as such can connect to the Engine through an EventSupplier and register to receive events. In addition, DisconnectableEventConsumer can also disconnect from the Engine using the Disconnect method
 CEventAn Event object representing an event instance in flat event string format and/or structured format (as defined by its associated Apama.Event.Parser.EventType)
 CEventConsumerAn EventConsumer can connect to the Engine through an EventSupplier and register to receive events. In order to receive events from the Engine, a developer must inherit from this class and define its SendEvents method. This method is called by the EventSupplier when events are emitted from the Engine
 CEventListenerAdapterEventListenerAdapter is a class that provides a skeletal implementation of the IEventListener interface to minimize effort required to implement the interface
 CEventSupplierAn EventSupplier represents the resources created by the Engine to service a connection to an external sink of events. It filters the event output of the Engine by delivering only the events emitted on a particular set of channels. An EventSupplier passes events to an EventConsumer. Call Dispose() after use, and before disposing of any associated EventConsumer
 CIEventListenerThe old-style IEventListener specifies an interface that classes can implement to receive events from an EventServiceChannel (see also HandleEventCallback)
 NNet
 NClient
 NInterfaces
 CBaseClientConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CIBaseClientIBaseClient is a class that specifies the base interface supported by all of the Engine Client layer
 CConnectionConstantsConnectionConstants is a class that holds a number of common default values for host, port and other settings
 NServices
 NEvent
 CChannelConfigChannelConfig is a helper class that assists in building a properties map for use when creating a new EventServiceChannel via the IEventService.AddChannel() method
 CCommunicationExceptionCommunicationException is a specialized exception for use with the Event Service that indicates that there is a problem communicating with the Correlator
 CEventServiceChannelConstantsIEventServiceChannel is the public interface for a class that represents a channel or channels on which events are received from a Correlator
 CEventServiceExceptionEventServiceException is a base exception class for all other specialized exceptions within with the Event Service
 CEventServiceFactoryEventServiceFactory is a class that provides a factory for creating new instances of classes that implement the IEventService interface
 CIEventServiceIEventService is an interface that represents the public API to the EventService
 CIEventServiceChannelThe Interface for an EventServiceChannel
 CIResponseListenerIResponseListener specifies the interface that classes must implement to receive the response part of an asynchronous request-response call
 CIResponseWrapperIResponseWrapper is an interface that specifies the public API for objects returned by the various request-response methods of the Event Service
 CResponseTimeoutExceptionResponseTimeoutException is a specialized exception for use with the Event Service that indicates that a request-response timeout has been exceeded
 NScenario
 CIllegalCallingThreadExceptionThrown when an attempt is made to change the state of running scenarios in the data queue processing thread
 CInvalidInputParameterExceptionInvalidInputParameterException is a specialized exception class that is used by classes of the Scenario Service to indicate that an invalid input parameter has been provided to create or edit a ScenarioInstance
 CIScenarioDefinitionIScenarioDefinition supports creating instances of a scenario, listening for added/removed/changed instances, and getting the information about the scenario definition itself (for example id, display name, input/output parameter names and types)
 CIScenarioInstanceIScenarioInstance supports getting the owner, last update time and current input/output parameter values of a scenario instance, listening for changes in individual instance parameters, and performing delete and edit operations on the instance
 CIScenarioServiceThe Scenario Service is an API for interacting with Apama applications from custom clients and dashboards running outside the correlator
 CParameterTypeHelperA convenience helper class for Apama.Services.Scenario.ParameterType
 CScenarioDefinitionConstants
 CScenarioServiceConfigScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory
 CScenarioServiceConstantsConstants used by the Scenario Service
 CScenarioServiceExceptionScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service
 CScenarioServiceFactoryScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface
 NUtil
 CApamaExceptionA base class for Apama exceptions that callers may wish to catch
 CLoggerThe Logger class provides access to the logging functionality used by Apama .NET classes
 CPropertyChangedEventArgsA "PropertyChanged" event gets delivered whenever an object changes a "bound" or "constrained" property. A PropertyChangeEvent object is sent as an argument to the PropertyChangeListener method
 CPropertyChangeSupportPropertyChangeSupport is a utility class to support maintaining property listeners, keyed by property name
 CEngineExceptionException class used for communications failure and other serious errors in any layer of the Apama engine client API stack
Submit a bug or feature
Copyright (c) 2013-2020 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.