Class Supervisor

Namespace

MassTransit.Middleware

Assembly

MassTransit.Abstractions.dll

Supervises a set of agents, allowing for graceful Start, Stop, and Ready state management

public class Supervisor : Agent, ISupervisor, IAgent

Inheritance

object

Agent

Supervisor

Implements

ISupervisor

IAgent

Inherited Members

Agent.Stop(StopContext)

Agent.SetNotReady(Exception)

Agent.SetReady(Task)

Agent.SetCompleted(Task)

Agent.SetFaulted(Task)

Agent.IsStopping

Agent.IsStopped

Agent.IsAlreadyReady

Agent.IsAlreadyCompleted

Agent.Ready

Agent.Completed

Agent.Stopping

Agent.Stopped

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AgentExtensions.Stop(IAgent, string, CancellationToken)

AgentExtensions.Stop(IAgent, CancellationToken)

Constructors

Supervisor()

Creates a Supervisor

public Supervisor()

Properties

PeakActiveCount

The peak number of agents active at the same time

public int PeakActiveCount { get; }

Property Value

int

TotalCount

The total number of agents that were added to the supervisor

public long TotalCount { get; }

Property Value

long

Methods

Add(IAgent)

Add an Agent to the Supervisor

public void Add(IAgent agent)

Parameters

agent IAgent

The agent

SetReady()

Puts the agent in a ready state, explicitly

public override void SetReady()

StopAgent(StopContext)

Stops the agent

protected override Task StopAgent(StopContext context)

Parameters

context StopContext

Returns

Task

StopSupervisor(StopSupervisorContext)

protected virtual Task StopSupervisor(StopSupervisorContext context)

Parameters

context StopSupervisorContext

Returns

Task