AddressHeader Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a header that encapsulates an address information item used to identify or interact with an endpoint.

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.AddressHeader

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Syntax

'Declaration
Public MustInherit Class AddressHeader

public abstract class AddressHeader

The AddressHeader type exposes the following members.

Constructors

	Name	Description
	AddressHeader	Initializes a new instance of the AddressHeader class.

Top

Properties

	Name	Description
	Name	When implemented, gets the name of the address header.
	Namespace	When implemented, gets the namespace of the address header.

Top

Methods

	Name	Description
	CreateAddressHeader(String, String, Object)	Creates a new instance of the AddressHeader class with a specified value, name and namespace.
	CreateAddressHeader(String, String, Object, XmlObjectSerializer)	Creates a new instance of the AddressHeader class with a specified name and namespace that uses a specified formatter to serialize the information item from a specified object.
	Equals	Determines whether the information item in a specified object is equal to the object contained in the current address header. (Overrides Object.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAddressHeaderReader	Returns an XML reader that can serialize the current address header object.
	GetHashCode	Provides a unique hash code for an address header. (Overrides Object.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue<T>()	Deserializes the information item from the current address header to an object of a specified type.
	GetValue<T>(XmlObjectSerializer)	Deserializes the information item from the current address header to an object of a specified type that uses a specified formatter to serialize this information.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnWriteAddressHeaderContents	When overridden in a derived class, is invoked when the address header contents are written to a stream or file.
	OnWriteStartAddressHeader	When overridden in a derived class, is invoked when the address header contents begin to be written to a stream or file.
	ToMessageHeader	Wraps the address header as a message header.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteAddressHeader(XmlDictionaryWriter)	Writes the address header to a stream or file using a specified XmlDictionaryWriter.
	WriteAddressHeader(XmlWriter)	Writes the address header to a stream or file using a specified XmlWriter.
	WriteAddressHeaderContents	Writes the address header contents to a stream or file.
	WriteStartAddressHeader	Starts to write the address header contents to a stream or file.

Top

Remarks

An AddressHeader is characterized by a name and namespace and has a value that contains optional information used to identify or interact with an endpoint. The name can be accessed by the Name property and the namespace by the Namespace property.

Examples

The following example shows how to create address headers, access their properties, add them to a service endpoint and host the service using the endpoint.

            ' Name property
            Dim addressHeaderWithName As AddressHeader = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service",1)
            Dim addressHeaderName As String = addressHeaderWithName.Name

            'Put snippet here.
            ' Namespace property
            Dim addressHeaderWithNS As AddressHeader = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service",1)
            Dim addressHeaderNS As String = addressHeaderWithNS.Namespace

            ' Create address headers for special services and add them to an array
            Dim addressHeader1 As AddressHeader = AddressHeader.CreateAddressHeader("specialservice1", "https://localhost:8000/service", 1)
            Dim addressHeader2 As AddressHeader = AddressHeader.CreateAddressHeader("specialservice2", "https://localhost:8000/service", 2)
            Dim addressHeaders() As AddressHeader = { addressHeader1, addressHeader2 }

            ' Endpoint address constructor with URI and address headers
            Dim endpointAddressWithHeaders As New EndpointAddress(New Uri("https://localhost/silverlightsamples/service1"), addressHeaders)

            ' Confirm adddressHeader1 is in endpointAddressWithHeaders - boolHeaders returns True.
            Dim addressHeaderCollection As AddressHeaderCollection = endpointAddressWithHeaders.Headers
            Dim boolHeaders As Boolean = addressHeaderCollection.Contains(addressHeader1)

            'Create address headers with XmlObjectSerializer specified
            Dim serializer As XmlObjectSerializer = New DataContractSerializer(GetType(Integer))
            Dim addressHeaderWithObjSer As AddressHeader = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service", 1, serializer)
            Dim value As Integer = addressHeaderWithObjSer.GetValue(Of Integer)()

            // Name property
            AddressHeader addressHeaderWithName = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service",1);
            string addressHeaderName = addressHeaderWithName.Name;

            //Put snippet here.
            // Namespace property
            AddressHeader addressHeaderWithNS = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service",1);
            string addressHeaderNS = addressHeaderWithNS.Namespace;

            // Create address headers for special services and add them to an array
            AddressHeader addressHeader1 = AddressHeader.CreateAddressHeader("specialservice1", "https://localhost:8000/service", 1);
            AddressHeader addressHeader2 = AddressHeader.CreateAddressHeader("specialservice2", "https://localhost:8000/service", 2);
            AddressHeader[] addressHeaders = new AddressHeader[2] { addressHeader1, addressHeader2 };

            // Endpoint address constructor with URI and address headers
            EndpointAddress endpointAddressWithHeaders = new EndpointAddress(
                new Uri("https://localhost/silverlightsamples/service1"), addressHeaders
                );

            // Confirm adddressHeader1 is in endpointAddressWithHeaders - boolHeaders returns True.
            AddressHeaderCollection addressHeaderCollection = endpointAddressWithHeaders.Headers;
            bool boolHeaders = addressHeaderCollection.Contains(addressHeader1);

            //Create address headers with XmlObjectSerializer specified
            XmlObjectSerializer serializer = new DataContractSerializer(typeof(int));
            AddressHeader addressHeaderWithObjSer = AddressHeader.CreateAddressHeader("MyServiceName", "https://localhost:8000/service", 1, serializer);
            int value = addressHeaderWithObjSer.GetValue<int>();

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.ServiceModel.Channels Namespace