Class MessageHeaderCollection

Namespace

Silverback.Messaging.Messages

Assembly

Silverback.Integration.dll

A modifiable collection of message headers.

public class MessageHeaderCollection : IReadOnlyList<MessageHeader>, IReadOnlyCollection<MessageHeader>, IEnumerable<MessageHeader>, IEnumerable

Inheritance

object

MessageHeaderCollection

Implements

IReadOnlyList<MessageHeader>

IReadOnlyCollection<MessageHeader>

IEnumerable<MessageHeader>

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MessageHeaderEnumerableExtensions.Contains(IEnumerable<MessageHeader>, string)

MessageHeaderEnumerableExtensions.GetValue(IEnumerable<MessageHeader>, string, bool)

MessageHeaderEnumerableExtensions.GetValue(IEnumerable<MessageHeader>, string, Type, bool)

MessageHeaderEnumerableExtensions.GetValueOrDefault(IEnumerable<MessageHeader>, string, Type)

MessageHeaderEnumerableExtensions.GetValueOrDefault<T>(IEnumerable<MessageHeader>, string)

MessageHeaderEnumerableExtensions.GetValue<T>(IEnumerable<MessageHeader>, string, bool)

MessageHeaderEnumerableExtensions.TryGetValue(IEnumerable<MessageHeader>, string, out string?)

Constructors

MessageHeaderCollection(IReadOnlyCollection<MessageHeader>)

Initializes a new instance of the MessageHeaderCollection class.

public MessageHeaderCollection(IReadOnlyCollection<MessageHeader> headers)

Parameters

headers IReadOnlyCollection<MessageHeader>

The headers to be added to the collection.

MessageHeaderCollection(int)

Initializes a new instance of the MessageHeaderCollection class.

public MessageHeaderCollection(int capacity = 0)

Parameters

capacity int

The initial capacity of the backing List<T>.

Properties

Count

public int Count { get; }

Property Value

int

this[int]

Gets the header at the specified index in the collection.

public MessageHeader this[int index] { get; set; }

Parameters

index int

The index in the collection.

Property Value

MessageHeader

this[string]

Gets or sets the value of the header with the specified name.

public string? this[string name] { get; set; }

Parameters

name string

The header name.

Property Value

string

Methods

Add(MessageHeader)

Adds a new header.

public void Add(MessageHeader header)

Parameters

header MessageHeader

The header to be added.

Add(string, object?)

Adds a new header.

public void Add(string name, object? value)

Parameters

name string

The header name.

value object

The header value.

Add(string, string?)

Adds a new header.

public void Add(string name, string? value)

Parameters

name string

The header name.

value string

The header value.

AddIfNotExists(string, object?)

Adds a new header if no header with the same name is already set.

public void AddIfNotExists(string name, object? newValue)

Parameters

name string

The header name.

newValue object

The new header value.

AddIfNotExists(string, string?)

Adds a new header if no header with the same name is already set.

public void AddIfNotExists(string name, string? newValue)

Parameters

name string

The header name.

newValue string

The new header value.

AddOrReplace(string, object?)

Adds a new header or replaces the header with the same name.

public void AddOrReplace(string name, object? newValue)

Parameters

name string

The header name.

newValue object

The new header value.

AddOrReplace(string, string?)

Adds a new header or replaces the header with the same name.

public void AddOrReplace(string name, string? newValue)

Parameters

name string

The header name.

newValue string

The new header value.

AddRange(IEnumerable<MessageHeader>)

Adds the new headers.

public void AddRange(IEnumerable<MessageHeader> headers)

Parameters

headers IEnumerable<MessageHeader>

The headers to be added.

Contains(string)

Returns a boolean value indicating whether an header with the specified name has already been added to the collection.

public bool Contains(string name)

Parameters

name string

The name to be checked.

Returns

bool

A boolean value indicating whether the name was found in the existing headers.

GetEnumerator()

public IEnumerator<MessageHeader> GetEnumerator()

Returns

IEnumerator<MessageHeader>

GetValue(string, bool)

Returns the value of the header with the specified name.

It will return null if no header with that name is found in the collection.

public string? GetValue(string name, bool throwIfNotFound = false)

Parameters

name string

The name of the header to be retrieved.

throwIfNotFound bool

A boolean value specifying whether an exception must be thrown if the header with the specified name is not found (or the value cannot be converted to the specified type).

Returns

string

The header value converted to the target type, or null if not found.

GetValue(string, Type, bool)

Returns the value of the header with the specified name, casting it to the specified type.

By default it will return null if no header with that name is found in the collection but this behavior can be changed setting the throwIfNotFound parameter to true.

public object? GetValue(string name, Type targetType, bool throwIfNotFound = false)

Parameters

name string

The name of the header to be retrieved.

targetType Type

The type to convert the header value to.

throwIfNotFound bool

A boolean value specifying whether an exception must be thrown if the header with the specified name is not found (or the value cannot be converted to the specified type).

Returns

object

The header value converted to the target type, or null if not found.

GetValueOrDefault(string, Type)

Returns the value of the header with the specified name, casting it to the specified type.

It will return the default value for the target type if no header with that name is found in the collection.

public object? GetValueOrDefault(string name, Type targetType)

Parameters

name string

The name of the header to be retrieved.

targetType Type

The type to convert the header value to.

Returns

object

The header value converted to the target type, or null if not found.

GetValueOrDefault<T>(string)

Returns the value of the header with the specified name, casting it to the specified type T.

It will return the default value for the type T if no header with that name is found in the collection.

public T GetValueOrDefault<T>(string name) where T : struct

Parameters

name string

The name of the header to be retrieved.

Returns

T

The header value converted to the target type, or null if not found.

Type Parameters

T

The type to convert the header value to.

GetValue<T>(string, bool)

Returns the value of the header with the specified name, casting it to the specified type T.

It will return null if no header with that name is found in the collection.

public T? GetValue<T>(string name, bool throwIfNotFound = false) where T : struct

Parameters

name string

The name of the header to be retrieved.

throwIfNotFound bool

A boolean value specifying whether an exception must be thrown if the header with the specified name is not found (or the value cannot be converted to the specified type).

Returns

T?

The header value converted to the target type, or null if not found.

Type Parameters

T

The type to convert the header value to.

Remove(MessageHeader)

Removes the specified header.

public void Remove(MessageHeader header)

Parameters

header MessageHeader

The header to remove.

Remove(string)

Removes all headers with the specified name.

public void Remove(string name)

Parameters

name string

The header name.

Replace(string, object?)

Replaces the specified header value.

public int Replace(string name, object? newValue)

Parameters

name string

The header name.

newValue object

The new header value.

Returns

int

The number of headers that have been replaced.

Replace(string, string?)

Replaces the specified header value.

public int Replace(string name, string? newValue)

Parameters

name string

The header name.

newValue string

The new header value.

Returns

int

The number of headers that have been replaced.

TryGetValue(string, out string?)

Checks whether a header with the specified name exists and returns its value.

public bool TryGetValue(string name, out string? value)

Parameters

name string

The name of the header to be retrieved.

value string

The header value.

Returns

bool

A value indicating whether the header was found.