Class StationStartedMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when the station has successfully started.

public class StationStartedMessage : RunningStationEventMessage, IAsyncHandlingMessage

Inheritance

object

RunningStationEventMessage

StationStartedMessage

Implements

IAsyncHandlingMessage

Inherited Members

RunningStationEventMessage.RunningStation

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

For the station to start, it must connect to Acuit Pinpoint and retrieve its configuration settings.

If a plug-in depends on key/value configuration settings that might come from Acuit Pinpoint, it should wait until this message is sent (or ensure that IWorkstationState.RunningStation is not null in case the plug-in is being loaded dynamically after the station has already started) to use Configuration to initialize.

This event can be raised more than once during the lifetime of the application if the Acuit Pinpoint connection is reconfigured while the application is running, either manually or automatically due to the active line changing to a linked line.

Constructors

StationStartedMessage(IRunningStation, CancellationToken)

Initializes a new instance of the StationStartedMessage class.

public StationStartedMessage(IRunningStation runningStation, CancellationToken cancellationToken)

Parameters

runningStation IRunningStation

The IRunningStation representing the running station.

cancellationToken CancellationToken

A token that can request cancellation of asynchronous handlers.

Exceptions

ArgumentNullException

runningStation is null.

Properties

AsyncHandlers

Gets the AsyncHandlers instance to which asynchronous handlers can be added.

public AsyncHandlers AsyncHandlers { get; }

Property Value

AsyncHandlers