Class WorkerLoggingOnMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when a worker is logging on to the station.

public class WorkerLoggingOnMessage : RunningStationEventMessage, IAsyncHandlingMessage, ICancelMessage

Inheritance

object

RunningStationEventMessage

WorkerLoggingOnMessage

Implements

IAsyncHandlingMessage

ICancelMessage

Inherited Members

RunningStationEventMessage.RunningStation

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A plug-in can use this message to prevent the worker from being logged on to the station by setting Cancel to true.

This message is sent for automated (i.e., unmanned) stations as well.

Constructors

WorkerLoggingOnMessage(IRunningStation, Worker?, int, CancellationToken)

Initializes a new instance of the WorkerLoggingOnMessage class.

public WorkerLoggingOnMessage(IRunningStation runningStation, Worker? worker, int workerId, CancellationToken cancellationToken)

Parameters

runningStation IRunningStation

The IRunningStation representing the running station.

worker Worker

The worker logging on, or null if the station is configured for automatic worker log on.

workerId int

The worker identification number of the worker logging on.

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

Cancel

Gets or sets whether to cancel the worker log on.

public bool Cancel { get; set; }

Property Value

bool

Worker

Gets the worker logging on, or null if the station is configured for automatic worker log on.

public Worker? Worker { get; }

Property Value

Worker

WorkerId

Gets the worker identification number of the worker logging on.

public int WorkerId { get; }

Property Value

int