MessageHeaders Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

MessageHeaders.cs

Represents a collection of message headers for a message. This class cannot be inherited.

public ref class MessageHeaders sealed : System::Collections::Generic::IEnumerable<System::ServiceModel::Channels::MessageHeaderInfo ^>

public sealed class MessageHeaders : System.Collections.Generic.IEnumerable<System.ServiceModel.Channels.MessageHeaderInfo>

type MessageHeaders = class
    interface seq<MessageHeaderInfo>
    interface IEnumerable

Public NotInheritable Class MessageHeaders
Implements IEnumerable(Of MessageHeaderInfo)

Inheritance

Object

MessageHeaders

Implements

IEnumerable<MessageHeaderInfo> IEnumerable

Examples

The following code example demonstrates a basic client using the channel factory to send a message and read the action header from the reply.

using System;
using System.Collections.Generic;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Runtime.Serialization;

namespace ConsoleApplication1
{
    class client
    {

        static void RunClient()
        {
            //Step1: create a binding with just HTTP
            CustomBinding binding = new CustomBinding();
            binding.Elements.Add(new HttpTransportBindingElement());
            //Step2: use the binding to build the channel factory
            IChannelFactory<IRequestChannel> factory =
            binding.BuildChannelFactory<IRequestChannel>(
                             new BindingParameterCollection());
            //open the channel factory
            factory.Open();
            //Step3: use the channel factory to create a channel
            IRequestChannel channel = factory.CreateChannel(
               new EndpointAddress("http://localhost:8080/channelapp"));
            channel.Open();
            //Step4: create a message
            Message requestmessage = Message.CreateMessage(
                MessageVersion.Soap12WSAddressing10,
                "http://contoso.com/someaction",
                 "This is the body data");
            //send message
            Message replymessage = channel.Request(requestmessage);
            Console.WriteLine("Reply message received");
            Console.WriteLine("Reply action: {0}",
                                  replymessage.Headers.Action);
            string data = replymessage.GetBody<string>();
            Console.WriteLine("Reply content: {0}", data);
            //Step5: don't forget to close the message
            requestmessage.Close();
            replymessage.Close();
            //don't forget to close the channel
            channel.Close();
            //don't forget to close the factory
            factory.Close();
        }
        public static void Main()
        {
            Console.WriteLine("Press [ENTER] when service is ready");
            Console.ReadLine();
            RunClient();
            Console.WriteLine("Press [ENTER] to exit");
            Console.ReadLine();
        }
    }
}

Imports System.Collections.Generic
Imports System.Text
Imports System.ServiceModel
Imports System.ServiceModel.Channels
Imports System.Runtime.Serialization

Namespace ConsoleApplication1
    Friend Class client


        Private Shared Sub RunClient()
            'Step1: create a binding with just HTTP
            Dim binding As New CustomBinding()
            binding.Elements.Add(New HttpTransportBindingElement())
            'Step2: use the binding to build the channel factory
            Dim factory As IChannelFactory(Of IRequestChannel) = binding.BuildChannelFactory(Of IRequestChannel)(New BindingParameterCollection())
            'open the channel factory
            factory.Open()
            'Step3: use the channel factory to create a channel
            Dim channel As IRequestChannel = factory.CreateChannel(New EndpointAddress("http://localhost:8080/channelapp"))
            channel.Open()
            'Step4: create a message
            Dim requestmessage As Message = Message.CreateMessage(MessageVersion.Soap12WSAddressing10, "http://contoso.com/someaction", "This is the body data")
            'send message
            Dim replymessage As Message = channel.Request(requestmessage)
            Console.WriteLine("Reply message received")
            Console.WriteLine("Reply action: {0}", replymessage.Headers.Action)
            Dim data = replymessage.GetBody(Of String)()
            Console.WriteLine("Reply content: {0}", data)
            'Step5: don't forget to close the message
            requestmessage.Close()
            replymessage.Close()
            'don't forget to close the channel
            channel.Close()
            'don't forget to close the factory
            factory.Close()
        End Sub
        Public Shared Sub Main()
            Console.WriteLine("Press [ENTER] when service is ready")
            Console.ReadLine()
            RunClient()
            Console.WriteLine("Press [ENTER] to exit")
            Console.ReadLine()
        End Sub
    End Class
End Namespace

Remarks

A message header contains optional metadata that describe a message encapsulated by the Message class.

A Message can have zero or more headers that are used as an extension mechanism to pass information in messages that are application-specific. You can use Headers to add message headers to a message by calling the Add method.

Windows Communication Foundation (WCF) provides a number of predefined message headers:

Header Name	Description
To	Contains the role that the message is targeting.
Action	Provides a description of how the message should be processed.
FaultTo	Contains the address of the node to which faults should be sent.
From	Contains the address of the node that sent the message.
Request	Indicates whether the message is a request.
MessageID	Contains the unique ID of the message.
RelatesTo	Contains the IDs of messages that are related to this message.
ReplyTo	Contains the address of the node to which a reply should be sent for a request.

Constructors

MessageHeaders(MessageHeaders)	Initializes a new instance of the MessageHeaders class with the specified collection of message headers.
MessageHeaders(MessageVersion, Int32)	Initializes a new instance of the MessageHeaders class with the specified message version and size.
MessageHeaders(MessageVersion)	Initializes a new instance of the MessageHeaders class with the specified message version.

Properties

Action	Gets or sets a description of how the message should be processed.
Count	Gets the number of message headers in this collection.
FaultTo	Gets or sets the address of the node to which faults should be sent.
From	Gets or sets the address of the node that sent the message.
Item[Int32]	Retrieves a header at the given index.
MessageId	Gets or sets the unique ID of the message.
MessageVersion	Gets the SOAP version of the message.
RelatesTo	Gets the IDs of messages that are related to this message.
ReplyTo	Gets or sets the address of the node to which a reply should be sent for a request.
To	Gets or sets the destination endpoint of a message.
UnderstoodHeaders	Gets all the message headers that must be understood, according to SOAP 1.1/1.2 specification.

Methods

Add(MessageHeader)	Adds the specified message header to the collection.
Clear()	Removes all the headers from the collection.
CopyHeaderFrom(Message, Int32)	Copies the header content located at the specified index from the specified message to this instance.
CopyHeaderFrom(MessageHeaders, Int32)	Copies the header content located at the specified index from the specified message header collection to this instance.
CopyHeadersFrom(Message)	Copies the content of all the headers from the specified message to this instance.
CopyHeadersFrom(MessageHeaders)	Copies the content from the specified header collection to this instance.
CopyTo(MessageHeaderInfo[], Int32)	Copies the headers from this collection to an array, starting at a particular index of the array.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindHeader(String, String, String[])	Finds a message header in this collection by the specified LocalName, namespace URI and actors of the header element.
FindHeader(String, String)	Finds a message header in this collection by the specified LocalName and namespace URI of the header element.
GetEnumerator()	Returns an enumerator for iterating through the collection. This method cannot be inherited.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetHeader<T>(Int32, XmlObjectSerializer)	Retrieves a message header at a specific position in this collection.
GetHeader<T>(Int32)	Retrieves a message header at a specific position in this collection.
GetHeader<T>(String, String, String[])	Retrieves a message header in this collection by the specified LocalName, namespace URI and actors of the header element.
GetHeader<T>(String, String, XmlObjectSerializer)	Retrieves a message header in this collection by the specified LocalName, namespace URI and serializer.
GetHeader<T>(String, String)	Finds a message header in this collection by the specified LocalName and namespace URI of the header element.
GetReaderAtHeader(Int32)	Gets a XML dictionary reader that consumes the message header at the specified location of the collection.
GetType()	Gets the Type of the current instance. (Inherited from Object)
HaveMandatoryHeadersBeenUnderstood()	Verifies whether all the message headers marked with MustUnderstand have been properly interpreted and processed.
HaveMandatoryHeadersBeenUnderstood(String[])	Verifies whether the specified recipients have properly interpreted and processed all the message headers marked with MustUnderstand.
Insert(Int32, MessageHeader)	Inserts a message header into the collection at the specified index.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RemoveAll(String, String)	Removes all headers with the specified name and namespace from the collection.
RemoveAt(Int32)	Removes the message header at the specified index from the collection.
SetAction(XmlDictionaryString)	Sets the action element of the header.
ToString()	Returns a string that represents the current object. (Inherited from Object)
WriteHeader(Int32, XmlDictionaryWriter)	Serializes the header from the specified location using the specified XML writer.
WriteHeader(Int32, XmlWriter)	Serializes the header from the specified location using the specified XML writer.
WriteHeaderContents(Int32, XmlDictionaryWriter)	Serializes the specified header content using the specified XML writer.
WriteHeaderContents(Int32, XmlWriter)	Serializes the specified header content using the specified XML writer.
WriteStartHeader(Int32, XmlDictionaryWriter)	Serializes the start header using the specified XML writer.
WriteStartHeader(Int32, XmlWriter)	Serializes the start header using the specified XML writer.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator for iterating through the collection. This method cannot be inherited.

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.