MessageHeaders 类

定义

命名空间:

System.ServiceModel.Channels

程序集:

System.ServiceModel.Primitives.dll

包:

System.ServiceModel.Primitives v6.2.0

表示消息的消息头集合。 此类不能被继承。

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)

继承

Object

MessageHeaders

实现

IEnumerable<MessageHeaderInfo> IEnumerable

示例

下面的代码示例演示一个基本客户端使用通道工厂发送消息并读取答复中的操作标头。

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

注解

消息头包含用于描述消息（由 Message 类包装）的可选元数据。

Message 可以没有标头或有一个或多个标头，这些标头作为一种扩展机制用来在特定于应用程序的消息中传递信息。 通过调用 Headers 方法，可使用 Add 将消息头添加到消息中。

Windows Communication Foundation (WCF) 提供了许多预定义的消息标头：

标头名称	说明
功能	包含作为消息投递目标的角色。
操作	提供应如何处理消息的说明。
FaultTo	包含错误应发送到的节点的地址。
从	包含发送消息的节点的地址。
请求	指示消息是否为请求。
消息 ID	包含消息的唯一 ID。
RelatesTo	包含与此消息相关的消息的 ID。
ReplyTo	包含对请求的答复应发送到的节点的地址。

构造函数

MessageHeaders(MessageHeaders)	使用指定的消息头集合初始化 MessageHeaders 类的新实例。
MessageHeaders(MessageVersion)	使用指定的消息版本初始化 MessageHeaders 类的新实例。
MessageHeaders(MessageVersion, Int32)	使用指定的消息版本和大小初始化 MessageHeaders 类的新实例。

属性

Action	获取或设置应如何处理消息的说明。
Count	获取此集合中的消息头数。
FaultTo	获取或设置错误应发送到的节点地址。
From	获取或设置发送消息的节点地址。
Item[Int32]	在给定的索引位置检索标头。
MessageId	获取或设置消息的唯一 ID。
MessageVersion	获取消息的 SOAP 版本。
RelatesTo	获取与此消息相关的消息 ID。
ReplyTo	获取或设置对请求的答复应发送到的节点地址。
To	获取或设置消息的目标终结点。
UnderstoodHeaders	获取必须按照 SOAP 1.1 和 1.2 规范解释的所有消息头。

方法

Add(MessageHeader)	将指定的消息头添加到集合。
Clear()	从集合中移除所有标头。
CopyHeaderFrom(Message, Int32)	将位于指定索引位置的标头内容从指定的消息复制到此实例。
CopyHeaderFrom(MessageHeaders, Int32)	将位于指定索引位置的标头内容从指定的消息头集合复制到此实例。
CopyHeadersFrom(Message)	将所有标头的内容从指定的消息复制到此实例。
CopyHeadersFrom(MessageHeaders)	将内容从指定的标头集合复制到此实例。
CopyTo(MessageHeaderInfo[], Int32)	将标头从此集合复制到一个数组中，并从该数组的某个特定索引位置开始。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
FindHeader(String, String)	使用标头元素的指定 LocalName 和命名空间 URI 在此集合中查找消息头。
FindHeader(String, String, String[])	使用标头元素的指定 LocalName、命名空间 URI 和操作者在此集合中查找消息头。
GetEnumerator()	返回迭代集合的一个枚举数。 无法继承此方法。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetHeader<T>(Int32)	在此集合中检索位于特定位置的消息头。
GetHeader<T>(Int32, XmlObjectSerializer)	在此集合中检索位于特定位置的消息头。
GetHeader<T>(String, String)	使用标头元素的指定 LocalName 和命名空间 URI 在此集合中查找消息头。
GetHeader<T>(String, String, String[])	使用标头元素的指定 LocalName、命名空间 URI 和操作者在此集合中检索消息头。
GetHeader<T>(String, String, XmlObjectSerializer)	使用指定 LocalName、命名空间 URI 和序列化程序在此集合中检索消息头。
GetReaderAtHeader(Int32)	获取一个 XML 字典读取器，该读取器使用位于集合中指定位置的消息头。
GetType()	获取当前实例的 Type。 (继承自 Object)
HaveMandatoryHeadersBeenUnderstood()	验证是否已正确解释和处理了所有标记为 MustUnderstand 的消息头。
HaveMandatoryHeadersBeenUnderstood(String[])	验证指定接收方是否已正确解释和处理了所有标记为 MustUnderstand 的消息头。
Insert(Int32, MessageHeader)	将消息头插入到集合中的指定索引位置。
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
RemoveAll(String, String)	从集合中移除具有指定名称和命名空间的所有标头。
RemoveAt(Int32)	从集合中移除位于指定索引位置的消息头。
SetAction(XmlDictionaryString)	设置标头的操作元素。
ToString()	返回表示当前对象的字符串。 (继承自 Object)
WriteHeader(Int32, XmlDictionaryWriter)	使用指定 XML 编写器从指定位置序列化标头。
WriteHeader(Int32, XmlWriter)	使用指定 XML 编写器从指定位置序列化标头。
WriteHeaderContents(Int32, XmlDictionaryWriter)	使用指定的 XML 编写器序列化指定的标头内容。
WriteHeaderContents(Int32, XmlWriter)	使用指定的 XML 编写器序列化指定的标头内容。
WriteStartHeader(Int32, XmlDictionaryWriter)	使用指定的 XML 编写器序列化开始标头。
WriteStartHeader(Int32, XmlWriter)	使用指定的 XML 编写器序列化开始标头。

显式接口实现

IEnumerable.GetEnumerator()

返回迭代集合的一个枚举数。 无法继承此方法。

扩展方法