Class ShutdownEventArgs

Namespace

RabbitMQ.Client.Events

Assembly

RabbitMQ.Client.dll

Information about the reason why a particular channel, session, or connection was destroyed.

public class ShutdownEventArgs : AsyncEventArgs

Inheritance

object

AsyncEventArgs

ShutdownEventArgs

Inherited Members

AsyncEventArgs.CancellationToken

AsyncEventArgs.CreateOrDefault(CancellationToken)

AsyncEventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

The ClassId and Initiator properties should be used to determine the originator of the shutdown event.

Constructors

ShutdownEventArgs(ShutdownInitiator, ushort, string, Exception, CancellationToken)

Construct a ShutdownEventArgs with the given parameters.

public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText, Exception exception, CancellationToken cancellationToken = default)

Parameters

initiator ShutdownInitiator

replyCode ushort

replyText string

exception Exception

cancellationToken CancellationToken

ShutdownEventArgs(ShutdownInitiator, ushort, string, object?, CancellationToken)

Construct a ShutdownEventArgs with the given parameters and 0 for ClassId and MethodId.

public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText, object? cause = null, CancellationToken cancellationToken = default)

Parameters

initiator ShutdownInitiator

replyCode ushort

replyText string

cause object

cancellationToken CancellationToken

ShutdownEventArgs(ShutdownInitiator, ushort, string, ushort, ushort, object?, CancellationToken)

Construct a ShutdownEventArgs with the given parameters.

public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText, ushort classId, ushort methodId, object? cause = null, CancellationToken cancellationToken = default)

Parameters

initiator ShutdownInitiator

replyCode ushort

replyText string

classId ushort

methodId ushort

cause object

cancellationToken CancellationToken

Properties

Cause

Object causing the shutdown, or null if none.

public object? Cause { get; }

Property Value

object

ClassId

AMQP content-class ID, or 0 if none.

public ushort ClassId { get; }

Property Value

ushort

Exception

Exception causing the shutdown, or null if none.

public Exception? Exception { get; }

Property Value

Exception

Initiator

Returns the source of the shutdown event: either the application, the library, or the remote peer.

public ShutdownInitiator Initiator { get; }

Property Value

ShutdownInitiator

MethodId

AMQP method ID within a content-class, or 0 if none.

public ushort MethodId { get; }

Property Value

ushort

ReplyCode

One of the standardised AMQP reason codes. See RabbitMQ.Client.Framing.*.Constants.

public ushort ReplyCode { get; }

Property Value

ushort

ReplyText

Informative human-readable reason text.

public string ReplyText { get; }

Property Value

string

Methods

ToString()

Override ToString to be useful for debugging.

public override string ToString()

Returns

string