MessageHeaders Classe

Définition

Espace de noms:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Paquet:

System.ServiceModel.Primitives v6.2.0

Source:

MessageHeaders.cs

Représente une collection d’en-têtes d’un message. Cette classe ne peut pas être héritée.

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)

Héritage

Object

MessageHeaders

Implémente

IEnumerable<MessageHeaderInfo> IEnumerable

Exemples

L'exemple de code suivant illustre un client de base qui utilise la fabrique de canal pour envoyer un message et lire l'en-tête d'action dans la réponse.

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

Remarques

Un en-tête de message contient des métadonnées facultatives qui décrivent un message, encapsulées par la classe Message.

Un Message peut comporter zéro ou plusieurs en-têtes utilisés comme un mécanisme d'extension pour passer des informations dans les messages qui sont spécifiques à l'application. Vous pouvez utiliser Headers pour ajouter des en-têtes de message à un message en appelant la méthode Add.

Windows Communication Foundation (WCF) fournit un certain nombre d’en-têtes de message prédéfinis :

Nom de l’en-tête	Description
À	Contient le rôle visé par le message.
Action	Décrit la manière dont le message doit être traité.
FaultTo	Contient l'adresse du nœud auquel les erreurs doivent être envoyées.
À partir	Contient l'adresse du nœud qui a envoyé le message.
Requête	Indique si le message est une demande.
MessageID	Contient l'ID unique du message.
RelatesTo	Contient les ID des messages liés à ce message.
ReplyTo	Contient l'adresse du nœud auquel une réponse doit être envoyée pour une demande.

Constructeurs

MessageHeaders(MessageHeaders)	Initialise une nouvelle instance de la classe MessageHeaders avec la collection d'en-têtes de message spécifiée.
MessageHeaders(MessageVersion)	Initialise une nouvelle instance de la classe MessageHeaders avec la version du message spécifiée.
MessageHeaders(MessageVersion, Int32)	Initialise une nouvelle instance de la classe MessageHeaders avec la version et la taille de message spécifiées.

Propriétés

Action	Obtient ou définit la description de la manière dont le message doit être traité.
Count	Obtient le nombre d’en-têtes de message dans cette collection.
FaultTo	Obtient ou définit l'adresse du nœud auquel les erreurs doivent être envoyées.
From	Obtient ou définit l'adresse du nœud qui a envoyé le message.
Item[Int32]	Récupère un en-tête à l'index indiqué.
MessageId	Obtient ou définit l'ID unique du message.
MessageVersion	Obtient la version SOAP du message.
RelatesTo	Obtient les ID des messages liés à ce message.
ReplyTo	Obtient ou définit l'adresse du nœud auquel une réponse doit être envoyée pour une demande.
To	Obtient ou définit le point de terminaison de destination d'un message.
UnderstoodHeaders	Obtient tous les en-têtes de message qui doivent être compris, selon la spécification SOAP 1.1/1.2.

Méthodes

Add(MessageHeader)	Ajoute l'en-tête de message spécifié à la collection.
Clear()	Supprime tous les en-têtes de la collection.
CopyHeaderFrom(Message, Int32)	Copie dans cette instance le contenu d'en-tête qui se trouve à l'index spécifié du message spécifié.
CopyHeaderFrom(MessageHeaders, Int32)	Copie dans cette instance le contenu d’en-tête qui se trouve à l’index spécifié à partir de la collection d’en-têtes de message spécifiée.
CopyHeadersFrom(Message)	Copie le contenu de tous les en-têtes du message spécifié dans cette instance.
CopyHeadersFrom(MessageHeaders)	Copie le contenu de la collection d’en-têtes spécifiée dans cette instance.
CopyTo(MessageHeaderInfo[], Int32)	Copie les en-têtes de cette collection dans un tableau, en commençant à un index particulier du tableau.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
FindHeader(String, String)	Recherche un en-tête de message dans cette collection en fonction du LocalName et l'URI d'espace de noms de l'élément d'en-tête spécifiés.
FindHeader(String, String, String[])	Recherche un en-tête de message dans cette collection en fonction du LocalName, de l’URI d’espace de noms et des acteurs de l’élément d’en-tête spécifiés.
GetEnumerator()	Renvoie un énumérateur pour itérer au sein de la collection. Cette méthode ne peut pas être héritée.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetHeader<T>(Int32)	Récupère un en-tête de message à une position spécifique dans cette collection.
GetHeader<T>(Int32, XmlObjectSerializer)	Récupère un en-tête de message à une position spécifique dans cette collection.
GetHeader<T>(String, String)	Recherche un en-tête de message dans cette collection en fonction du LocalName et l'URI d'espace de noms de l'élément d'en-tête spécifiés.
GetHeader<T>(String, String, String[])	Récupère un en-tête de message dans cette collection en fonction du LocalName, de l’URI d’espace de noms et des acteurs de l’élément d’en-tête spécifiés.
GetHeader<T>(String, String, XmlObjectSerializer)	Récupère un en-tête de message dans cette collection en fonction du LocalName, de l'URI d'espace de noms et du sérialiseur spécifiés.
GetReaderAtHeader(Int32)	Obtient un lecteur de dictionnaire XML qui consomme l'en-tête de message à l'emplacement spécifié de la collection.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
HaveMandatoryHeadersBeenUnderstood()	Vérifie si tous les en-têtes de message marqués avec MustUnderstand ont été correctement interprétés et traités.
HaveMandatoryHeadersBeenUnderstood(String[])	Vérifie si les destinataires spécifiés ont correctement interprété et traité tous les en-têtes de message marqués avec MustUnderstand.
Insert(Int32, MessageHeader)	Insère un en-tête de message dans la collection à la position d’index spécifiée.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
RemoveAll(String, String)	Supprime de la collection tous les en-têtes avec le nom et l’espace de noms spécifiés.
RemoveAt(Int32)	Supprime de la collection l'en-tête de message à l'index spécifié.
SetAction(XmlDictionaryString)	Définit l'élément d'action de l'en-tête.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
WriteHeader(Int32, XmlDictionaryWriter)	Sérialise l'en-tête à partir de l'emplacement spécifié à l'aide de l'enregistreur XML spécifié.
WriteHeader(Int32, XmlWriter)	Sérialise l'en-tête à partir de l'emplacement spécifié à l'aide de l'enregistreur XML spécifié.
WriteHeaderContents(Int32, XmlDictionaryWriter)	Sérialise le contenu de l'en-tête spécifié à l'aide de l'enregistreur XML spécifié.
WriteHeaderContents(Int32, XmlWriter)	Sérialise le contenu de l'en-tête spécifié à l'aide de l'enregistreur XML spécifié.
WriteStartHeader(Int32, XmlDictionaryWriter)	Sérialise l'en-tête de début à l'aide du writer XML spécifié.
WriteStartHeader(Int32, XmlWriter)	Sérialise l'en-tête de début à l'aide du writer XML spécifié.

Implémentations d’interfaces explicites

IEnumerable.GetEnumerator()

Renvoie un énumérateur pour itérer au sein de la collection. Cette méthode ne peut pas être héritée.

Méthodes d’extension