Apama API Reference for .NET
10.2.0.3
|
ScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface. More...
Static Public Member Functions | |
static IScenarioService | CreateScenarioService (string socketHostName, int socketPort, Dictionary< string, object > scenarioServiceConfig, PropertyChangedEventHandler listener) |
Create a new ScenarioService instance with an IMessagingClient connected to a Correlator on the given host and port, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService. More... | |
static IScenarioService | CreateScenarioService (string socketHostName, int socketPort, string processName, Dictionary< string, object > scenarioServiceConfig, PropertyChangedEventHandler listener) |
Create a new ScenarioService instance with an IMessagingClient connected to a Correlator on the given host and port, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService. More... | |
static IScenarioService | CreateScenarioService (IMessagingClient messagingClient, Dictionary< string, object > scenarioServiceConfig, PropertyChangedEventHandler listener) |
Create a new ScenarioService instance using the supplied IMessagingClient to connect to a Correlator, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService. More... | |
static IScenarioService | CreateScenarioService (IEventService eventService, Dictionary< string, object > scenarioServiceConfig, PropertyChangedEventHandler listener) |
Create a new ScenarioService instance using the supplied IEventService to connect to a Correlator, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService. More... | |
ScenarioServiceFactory is a class that provides factory methods for creating new instances of classes that implement the IScenarioService interface.
Note that Queries and DataViews are both represented as "scenarios" in this API.
There are 3 variants of the factory methods:
For each of the above factory methods, the client must also supply parameters for a configuration map, and a listener. Either of those additional parameters may be null. For more details of the configuration parameter, see the documentation for IScenarioService, and ScenarioServiceConfig. The names of the bound properties for which the listener will be notified are those properties of ScenarioServiceConstants whose names begin "Property", e.g. ScenarioServiceConstants.PropertyScenarioAdded
|
static |
Create a new ScenarioService instance with an IMessagingClient connected to a Correlator on the given host and port, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService.
The EventService and MessagingClient associated with this ScenarioService will be disposed automatically, when the scenario service is disposed.
socketHostName | Name of the host where the Correlator is running. |
socketPort | Port number on which the Correlator is listening. |
scenarioServiceConfig | Configuration properties for the scenario service. (The Map may also contain EventServiceChannel configuration properties.) |
listener | The listener to be notified of property changes. |
|
static |
Create a new ScenarioService instance with an IMessagingClient connected to a Correlator on the given host and port, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService.
The EventService and MessagingClient associated with this ScenarioService will be disposed automatically, when the scenario service is disposed.
socketHostName | Name of the host where the Correlator is running. |
socketPort | Port number on which the Correlator is listening. |
processName | A display name to identify which application is responsible for this connection to the Correlator (this name is included in log files for diagnostic purposes) |
scenarioServiceConfig | Configuration properties for the scenario service. (The Map may also contain EventServiceChannel configuration properties.) |
listener | The listener to be notified of property changes. |
|
static |
Create a new ScenarioService instance using the supplied IMessagingClient to connect to a Correlator, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService.
Is it the caller's responsibility to Dispose the supplied messagingClient, after the scenario service has been disposed. The implicitly created EventService will be disposed automatically.
messagingClient | The IMessagingClient to be used by the new scenario service. |
scenarioServiceConfig | Configuration properties for the scenario service. (The Map may also contain EventServiceChannel configuration properties.) |
listener | The listener to be notified of property changes. |
|
static |
Create a new ScenarioService instance using the supplied IEventService to connect to a Correlator, and optionally pass a listener that will be added before any events are received. The listener will be notified of changes to any bound property of this IScenarioService.
Is it the caller's responsibility to Dispose the supplied eventService, after the scenario service has been disposed.
eventService | the IEventService to be used by the new scenario service. |
scenarioServiceConfig | Configuration properties for the scenario service. (The Map may also contain EventServiceChannel configuration properties.) |
listener | The listener to be notified of property changes. |