Microsoft.Coyote.Actors assembly

Microsoft.Coyote.Actors namespace

public type description
abstract class Actor Type that implements an actor. Inherit from this class to declare a custom actor.
enum ActorExecutionStatus The execution status of an actor.
class ActorId Unique actor id.
class ActorRuntimeLogTextFormatter This class implements IActorRuntimeLog and generates output in a a human readable text format.
class AwaitableEventGroup<T> An object representing an awaitable long running context involving one or more actors. An AwaitableEventGroup can be provided as an optional argument in CreateActor and SendEvent. If a null AwaitableEventGroup is passed then the EventGroup is inherited from the sender or target actors (based on which ever one has a CurrentEventGroup). In this way an AwaitableEventGroup is automatically communicated to all actors involved in completing some larger operation. Each actor involved can find the AwaitableEventGroup using their CurrentEventGroup property.
class DefaultEvent A default event that is generated by the runtime when no user-defined event is dequeued or received.
enum DequeueStatus The status returned as the result of an Actor dequeue operation.
abstract class Event Abstract class representing an event that can be send to an Actor or StateMachine.
class EventGroup An object representing a long running context involving one or more actors. An EventGroup can be provided as an optional argument in CreateActor and SendEvent. If a null EventGroup is passed then the EventGroup is inherited from the sender or target actors (based on which ever one has a CurrentEventGroup). In this way an EventGroup is automatically communicated to all actors involved in completing some larger operation. Each actor involved can find the EventGroup using their CurrentEventGroup property.
class HaltEvent The halt event.
interface IActorRuntime Interface that exposes runtime methods for creating and executing actors.
interface IActorRuntimeLog Interface that allows an external module to track what is happening in the IActorRuntime.
delegate OnActorHaltedHandler Handles the OnActorHalted event.
delegate OnEventDroppedHandler Handles the OnEventDropped event.
enum OnExceptionOutcome The outcome when an Actor throws an exception.
static class RuntimeFactory Provides methods for creating a IActorRuntime runtime.
class SendOptions Represents a send event configuration that is used during testing.
abstract class StateMachine Type that implements a state machine actor. Inherit from this class to declare a custom actor with states, state transitions and event handlers.
class UnhandledEventException Signals that an Actor received an unhandled event.
class WildCardEvent The wild card event.

Microsoft.Coyote.Actors.Coverage namespace

public type description
class ActorCoverageInfo Class for storing actor coverage-specific data across multiple testing iterations.
class ActorEventCoverage This class maintains information about events received and sent from each state of each actor.

Microsoft.Coyote.Actors.SharedObjects namespace

public type description
class SharedCounter A thread-safe counter that can be shared in-memory by actors.
class SharedDictionary<TKey,TValue> A thread-safe dictionary that can be shared in-memory by actors.
static class SharedDictionary A thread-safe dictionary that can be shared in-memory by actors.
class SharedRegister<T> A thread-safe register that can be shared in-memory by actors.
static class SharedRegister A thread-safe register that can be shared in-memory by actors.

Microsoft.Coyote.Actors.Timers namespace

public type description
class TimerElapsedEvent Defines a timer elapsed event that is sent from a timer to the actor that owns the timer.
class TimerInfo Stores information about a timer that can send timeout events to its owner actor.