Class Headers

Namespace

RabbitMQ.Client

Assembly

RabbitMQ.Client.dll

Convenience class providing compile-time names for standard headers.

public static class Headers

Inheritance

object

Headers

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use the static members of this class as headers for the arguments for Queue and Exchange declaration or Consumer creation. The broker may be extended with additional headers that do not appear in this class.

Fields

AlternateExchange

alternate-exchange header

public const string AlternateExchange = "alternate-exchange"

Field Value

string

XDeadLetterExchange

x-dead-letter-exchange header

public const string XDeadLetterExchange = "x-dead-letter-exchange"

Field Value

string

XDeadLetterRoutingKey

x-dead-letter-routing-key header

public const string XDeadLetterRoutingKey = "x-dead-letter-routing-key"

Field Value

string

XExpires

x-expires header

public const string XExpires = "x-expires"

Field Value

string

XMaxAge

x-max-age header Sets the maximum age of the stream. Default: not set. valid units: Y, M, D, h, m, s e.g. 7D for a week

public const string XMaxAge = "x-max-age"

Field Value

string

XMaxLength

x-max-length header The max total size in bytes

public const string XMaxLength = "x-max-length"

Field Value

string

XMaxLengthInBytes

x-max-length-bytes header

public const string XMaxLengthInBytes = "x-max-length-bytes"

Field Value

string

XMaxPriority

x-max-priority header

public const string XMaxPriority = "x-max-priority"

Field Value

string

XMessageTTL

x-message-ttl header

public const string XMessageTTL = "x-message-ttl"

Field Value

string

XOverflow

x-overflow header. Available strategies: "reject-publish" and "drop-head"(default). Allows to configure strategy when XMaxLength or XMaxLengthInBytes hits limits

public const string XOverflow = "x-overflow"

Field Value

string

XPriority

x-priority header

public const string XPriority = "x-priority"

Field Value

string

XQueueMode

x-queue-mode header. Available modes: "default" and "lazy"

public const string XQueueMode = "x-queue-mode"

Field Value

string

XQueueType

x-queue-type header. Available types: "quorum" and "classic"(default) and "stream"

public const string XQueueType = "x-queue-type"

Field Value

string

XQuorumInitialGroupSize

x-quorum-initial-group-size header. Use to control the number of quorum queue members

public const string XQuorumInitialGroupSize = "x-quorum-initial-group-size"

Field Value

string

XSingleActiveConsumer

x-single-active-consumer header. Available modes: true and false(default). Allows to have only one consumer at a time consuming from a queue and to fail over to another registered consumer in case the active one is cancelled or dies

public const string XSingleActiveConsumer = "x-single-active-consumer"

Field Value

string

XStreamMaxSegmentSizeInBytes

x-stream-max-segment-size-bytes header A stream is divided up into fixed size segment files on disk. This setting controls the size of these. Default: (500000000 bytes).

public const string XStreamMaxSegmentSizeInBytes = "x-stream-max-segment-size-bytes"

Field Value

string

XStreamOffset

x-stream-offset header. As streams never delete any messages, any consumer can start reading/consuming from any point in the log. this is controlled by the x-stream-offset consumer argument. Available values: "first", "last", "next", Timestamp and Interval (valid units: Y, M, D, h, m, s) See more

public const string XStreamOffset = "x-stream-offset"

Field Value

string