MessageProperties Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

MessageProperties.cs

Represents a set of properties for a message. This class cannot be inherited.

public ref class MessageProperties sealed : IDisposable, System::Collections::Generic::ICollection<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>, System::Collections::Generic::IDictionary<System::String ^, System::Object ^>, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>>

public sealed class MessageProperties : IDisposable, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>

type MessageProperties = class
    interface ICollection<KeyValuePair<string, obj>>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
    interface IDictionary<string, obj>
    interface IDisposable

Public NotInheritable Class MessageProperties
Implements ICollection(Of KeyValuePair(Of String, Object)), IDictionary(Of String, Object), IDisposable, IEnumerable(Of KeyValuePair(Of String, Object))

Inheritance

Object

MessageProperties

Implements

ICollection<KeyValuePair<String,Object>> ICollection<KeyValuePair<TKey,TValue>> IDictionary<String,Object> IEnumerable<KeyValuePair<String,Object>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IEnumerable IDisposable

Remarks

As a message passes through the channel infrastructure, it passes through a number of logically separate processing entities. For instance, a message that is part of a reliable messaging stream can potentially pass through a MessageEncoder, a transport-level channel provider, the reliable-messaging channel provider, the streaming channel provider or any channel extensions. Sometimes these intermediaries annotate the message with the results of that processing by using the MessageProperties class. A MessageProperties instance is an annotation on a message and is stored as a set of name-to-object mappings in the Properties property of a Message instance.

Note

The message properties should be cleared out when the user gets the following error:

The server committed a protocol violation. Section=ResponseBody Detail=Response chunk format is invalid

Constructors

MessageProperties()	Initializes a new instance of the MessageProperties class.
MessageProperties(MessageProperties)	Initializes a new instance of the MessageProperties class with preset properties.

Properties

AllowOutputBatching	Gets or sets a value that specifies whether to store this message before giving it to the transport.
Count	Gets the total number of properties in the MessageProperties.
Encoder	Gets the encoder that is used to write messages to a stream and to read messages from a stream.
IsFixedSize	Gets a value that indicates whether the MessageProperties has a fixed size.
Item[String]	Retrieves a property with the specified name, identifier, or key value.
Keys	Gets an ICollection that contains the keys in the MessageProperties.
Security	Gets or sets the security-related property of a message.
Values	Gets an ICollection that contains the values in the MessageProperties.
Via	Gets or sets the transport address that is used to send messages.

Methods

Add(String, Object)	Adds an element with the specified name and property into the MessageProperties collection.
Clear()	Removes all elements from the MessageProperties collection.
ContainsKey(String)	Determines whether the MessageProperties contains a specific name, key, or identifier.
CopyProperties(MessageProperties)	Copies the content of the specified MessageProperties to this instance.
Dispose()	Releases all resources used by the MessageProperties class.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Remove(String)	Removes the element with the specified name from the MessageProperties.
ToString()	Returns a string that represents the current object. (Inherited from Object)
TryGetValue(String, Object)	Determines whether the MessageProperties contains a specific name, and retrieves its value.

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)	Adds an element with the specified name and property into the MessageProperties.
ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)	Determines whether the MessageProperties contains a specific name.
ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)	Copies the content of the specified MessageProperties to an array, starting at the specified index.
ICollection<KeyValuePair<String,Object>>.IsReadOnly	Gets a value indicating whether the ICollection<T> is read-only.
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)	Removes the element with the specified name from the MessageProperties.
IEnumerable.GetEnumerator()	Returns an enumerator that can iterate through a collection.
IEnumerable<KeyValuePair<String,Object>>.GetEnumerator()	Returns an enumerator that can iterate through a collection.

Extension Methods

ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector function.
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector and element selector functions.
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	Creates a FrozenSet<T> with the specified values.
ToImmutableArray<TSource>(IEnumerable<TSource>)	Creates an immutable array from the specified collection.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	Enumerates a sequence and produces an immutable sorted set of its contents.