Apama API Reference for .NET  9.12.0.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1234]
 CApamaException
 CApama.Services.Event.EventServiceExceptionEventServiceException is a base exception class for all other specialized exceptions within with the Event Service
 CApama.Services.Event.CommunicationExceptionCommunicationException is a specialized exception for use with the Event Service that indicates that there is a problem communicating with the Correlator
 CApama.Services.Event.ResponseTimeoutExceptionResponseTimeoutException is a specialized exception for use with the Event Service that indicates that a request-response timeout has been exceeded
 CApama.Engine.ApiThe Api class contains static methods to initialise and stop the client interface.
 CApplicationException
 CApama.Util.ApamaExceptionA base class for Apama exceptions that callers may wish to catch.
 CApama.EngineExceptionException class used for communications failure and other serious errors in any layer of the Apama engine client API stack.
 CApama.Net.Client.Interfaces.BaseClientConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CApama.Services.Event.ChannelConfigChannelConfig is a helper class that assists in building a properties map for use when creating a new EventServiceChannel via the IEventService.AddChannel() method
 CApama.Net.ConnectionConstantsConnectionConstants is a class that holds a number of common default values for host, port and other settings.
 CApama.Engine.Client.ConsumerOperationsConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CApama.Engine.Client.CorrelatorManagementConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CApama.Event.Parser.DecimalFieldValueRepresents the value of an Apama decimal field, using Decimal or Double objects.
 CApama.Engine.Client.EngineClientConstantsA static class containing constants used by the engine client interfaces.
 CApama.Engine.Client.EngineClientFactoryEngineClientFactory is a factory for classes that implement Apama messaging or correlator management interfaces
 CApama.Engine.EngineConnectionEngineConnection encapsulates the information related to a connection between two Apama messaging components
 CApama.Engine.EngineInfoThis class provides access to all of the information returned from an engine as a result of a call to the InspectEngine() method
 CApama.Engine.EngineStatusEngineStatus represents the operational status of the Engine.
 CApama.Event.EventAn Event object representing an event instance in flat event string format and/or structured format (as defined by its associated Apama.Event.Parser.EventType).
 CApama.Event.Parser.EventParserProvides the functionality to parse System.String objects into Apama Apama.Event.Event objects, for any EventType registered with the parser.
 CApama.Services.Event.EventServiceChannelConstantsIEventServiceChannel is the public interface for a class that represents a channel or channels on which events are received from a Correlator
 CApama.Services.Event.EventServiceFactoryEventServiceFactory is a class that provides a factory for creating new instances of classes that implement the IEventService interface.
 CException
 CApama.Event.Parser.ParserRuntimeExceptionParserRuntimeException will be thrown when an error occurs while parsing an Apama event.
 CException
 CApama.Services.Scenario.ScenarioServiceExceptionScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service
 CApama.Services.Scenario.InvalidInputParameterExceptionInvalidInputParameterException 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
 CApama.Event.Parser.FieldNon-generic class holding the name and type of a field in an EventType (with reduced compile-time type safety compared to generic Field<T> class).
 CApama.Event.Parser.Field< T >Represents the name and type of a field in an EventType.
 CApama.Event.Parser.FieldTypeNon-generic abstract base class representing an Apama type (with reduced compile-time type safety).
 CApama.Event.Parser.DictionaryFieldTypeNon-generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.IDictionary objects.
 CApama.Event.Parser.FieldType< T >Represents 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.
 CApama.Event.Parser.ContextFieldTypeRepresents the Apama context type, for which values are specified as String objects.
 CApama.Event.Parser.OptionalFieldType< OptionalT, BaseT >Represents the Apama optional type, for which the contained types are specified as either PrimitiveFieldType<T> or ReferenceFieldType<T> objects.
 CApama.Event.Parser.PrimitiveFieldType< T >Abstract 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
 CApama.Event.Parser.BooleanFieldTypeRepresents the Apama boolean type, for which values are specified as Boolean objects.
 CApama.Event.Parser.FloatFieldTypeRepresents the Apama float type, for which values are specified as Double objects.
 CApama.Event.Parser.IntegerFieldTypeRepresents the Apama integer type, for which values are specified as Int64 objects.
 CApama.Event.Parser.ReferenceFieldType< T >Abstract 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
 CApama.Event.Parser.ChannelFieldTypeRepresents the Apama Channel type, for which values are specified as String objects.
 CApama.Event.Parser.DecimalFieldTypeRepresents the Apama decimal type, for which values are specified as DecimalFieldValue objects.
 CApama.Event.Parser.DictionaryFieldType< TKey, TValue >Generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.Generic.IDictionary<K,V> objects.
 CApama.Event.Parser.EventTypeRepresents 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.
 CApama.Event.Parser.LocationFieldTypeRepresents the Apama location type, for which values are specified as LocationType objects.
 CApama.Event.Parser.SequenceFieldType< E >Generic class that represents the Apama sequence<type> type, for which values are specified as System.Collections.Generic.IList<E> objects.
 CApama.Event.Parser.StringFieldTypeRepresents the Apama string type, for which values are specified as String objects.
 CApama.Event.Parser.SequenceFieldTypeNon-generic class that represents the Apama sequence<type> type, for which values are specified as System.Collections.IList objects.
 CApama.Event.Parser.FieldTypesProvides factory methods and constants for getting all supported Apama event field types.
 CIBaseClient
 CApama.Engine.Client.ICorrelatorManagementICorrelatorManagement is the interface for all management operations that can be performed on an Apama Correlator
 CApama.Engine.Client.IEngineClientProvides 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.
 CApama.Engine.Client.IConnectOperationsIConnectOperations is an interface that specifies methods for connecting an engine as a consumer of another engine
 CApama.Engine.Client.IEngineClientProvides 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.
 CApama.Engine.Client.IConsumerOperationsIConsumerOperations is an interface that specifies the standard operations to enable a client to receive events on specific channels from a remote Correlator.
 CIDisposable
 CApama.Event.EventConsumerAn 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.
 CApama.Engine.EngineManagementThe EngineManagement interface is the primary low-level interface to the Engine, and allows operations to be carried out on it.
 CApama.Event.DisconnectableEventConsumerThis 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.
 CApama.Event.EventSupplierAn 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.
 CApama.Net.Client.IBaseClientIBaseClient is a class that specifies the base interface supported by all of the Engine Client layer.
 CApama.Engine.Client.IMessagingClientThis 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).
 CApama.Engine.Client.IEngineClientProvides 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.
 CApama.Services.Event.IEventServiceIEventService is an interface that represents the public API to the EventService.
 CApama.Services.Event.IResponseWrapperIResponseWrapper is an interface that specifies the public API for objects returned by the various request-response methods of the Event Service
 CApama.Services.Scenario.IScenarioServiceIScenarioService is an interface that represents the public API to the ScenarioService.
 CApama.Event.IEventListenerThe old-style IEventListener specifies an interface that classes can implement to receive events from an EventServiceChannel (see also HandleEventCallback).
 CApama.Event.EventListenerAdapterEventListenerAdapter is a class that provides a skeletal implementation of the IEventListener interface to minimize effort required to implement the interface.
 CApama.Services.Event.IEventServiceChannelThe Interface for an EventServiceChannel
 CApama.Engine.Client.IReconnectPolicyIReconnectPolicy is a policy that can be set on an EngineClient object which controls when it should reconnect
 CApama.Services.Event.IResponseListenerIResponseListener specifies the interface that classes must implement to receive the response part of an asynchronous request-response call
 CApama.Services.Scenario.IScenarioDefinitionIScenarioDefinition is the public interface for a class that represents a Scenario (not an instance).
 CApama.Services.Scenario.IScenarioInstanceIScenarioInstance is the public interface for a class that represents a Scenario instance
 CApama.Event.Parser.LocationTypeRepresents the value of an Apama location type, consisting of of two (x,y) co-ordinates.
 CApama.Util.LoggerThe Logger class provides access to the logging functionality used by Apama .NET classes
 CApama.Engine.Client.MessagingClientConstantsLegacy constants class - Deprecated - Use Apama.Engine.Client.EngineClientConstants instead.
 CApama.Engine.MonitorScriptA MonitorScript object encapsulates a MonitorScript code fragment, containing package, event and monitor definitions to be injected into an Engine.
 CApama.Engine.NameInfoThis 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.
 CApama.Engine.NamedAggregateInfoThis class provides access to a snapshot of information about an aggregate that is/was live in the engine.
 CApama.Engine.NamedContextInfoThis class provides access to a snapshot of information about a Context that is/was live in the engine.
 CApama.Engine.NamedEventTypeInfoThis class provides access to a snapshot of information about a Monitor that is/was live in the engine.
 CApama.Engine.NamedJavaApplicationInfoThis class provides access to a snapshot of information about a Java (JMon) Application that is/was live in the engine
 CApama.Engine.NamedMonitorInfoThis class provides access to a snapshot of information about a Monitor that is/was live in the engine.
 CApama.Engine.NamedPluginReceiverInfoThis class provides access to a snapshot of information about a PluginReceiver that is/was connected to the engine.
 CApama.Engine.NamedReceiverInfoThis class provides access to a snapshot of information about a Receiver that is/was connected to the engine.
 CApama.Engine.NamedTimerInfoThis class provides access to a snapshot of information about a Timer that is/was live in the engine.
 CApama.Services.Scenario.ParameterTypeHelperA convenience helper class for Apama.Services.Scenario.ParameterType.
 CPropertyChangedEventArgs
 CApama.Util.PropertyChangedEventArgsA "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
 CApama.Util.PropertyChangeSupportPropertyChangeSupport is a utility class to support maintaining property listeners, keyed by property name.
 CApama.Services.Scenario.ScenarioDefinitionConstants
 CApama.Services.Scenario.ScenarioServiceConfigScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory
 CApama.Services.Scenario.ScenarioServiceConstantsConstants used by the Scenario Service.
 CApama.Services.Scenario.ScenarioServiceFactoryScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface.
 CSystemException
 CApama.Services.Scenario.IllegalCallingThreadExceptionThrown when an attempt is made to change the state of running scenarios in the data queue processing thread
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.