BinaryMessageEncodingBindingElement Class

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

The binding element that specifies the .NET Binary Format for XML used to encode messages.

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.BindingElement
    System.ServiceModel.Channels.MessageEncodingBindingElement
      System.ServiceModel.Channels.BinaryMessageEncodingBindingElement

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

Syntax

'Declaration
Public NotInheritable Class BinaryMessageEncodingBindingElement _
    Inherits MessageEncodingBindingElement

public sealed class BinaryMessageEncodingBindingElement : MessageEncodingBindingElement

The BinaryMessageEncodingBindingElement type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	MessageVersion	Gets or sets the SOAP message and WS-Addressing versions that are used or expected. (Overrides MessageEncodingBindingElement.MessageVersion.)

Top

Methods

	Name	Description
	BuildChannelFactory<TChannel>	Builds the channel factory stack on the client that creates a specified type of channel for a specified context. (Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)
	CanBuildChannelFactory<TChannel>	Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel. (Inherited from BindingElement.)
	Clone	Creates a new BinaryMessageEncodingBindingElement object initialized from the current one. (Overrides BindingElement.Clone().)
	CreateMessageEncoderFactory	Creates a factory for binary message encoders that employ the SOAP and WS-Addressing versions and the character encoding specified by the current encoding binding element. (Overrides MessageEncodingBindingElement.CreateMessageEncoderFactory().)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from 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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetProperty<T>	Returns the typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from MessageEncodingBindingElement.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Encoding is the process of transforming a message into a sequence of bytes. Decoding is the reverse process. Silverlight 5 includes two types of encoding for SOAP messages: Text and Binary.

The BinaryMessageEncodingBindingElement is the binding element that specified the .NET Binary Format for XML should be used for encoding messages, and has options to specify the character encoding and the SOAP and WS-Addressing version to be used. Binary encoding is the most efficient but least interoperable of the encoding options.

For more information about

the binding element that specifies messages are encoded using a textual representation of XML, see TextMessageEncodingBindingElement.

To implement a custom message encoder, use the MessageEncodingBindingElement class.

Examples

    ' This is an example of how to create a custom binding with a specified encoding and tansport,
    ' and how to create and open a channel for the service endpoint configured with the custom binding.
    Partial Public Class MainPage
        Inherits UserControl
        'Declare a separate UI thread.
        Private uiThread As SynchronizationContext

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)

            'Create a custom binding that uses HTTP and binary message encoding.
            Dim elements = New List(Of BindingElement)()
            elements.Add(New BinaryMessageEncodingBindingElement())
            elements.Add(New HttpTransportBindingElement())
            Dim binding = New CustomBinding(elements)

            'Create a channel factory for the service endpoint configured with the custom binding.
            Dim cf = New ChannelFactory(Of IService1)(binding, New EndpointAddress("https://localhost:10483/Service1.svc"))


            'Save the synchronized context for the UI thread.
            uiThread = SynchronizationContext.Current

            'Open the channel.
            Dim channel As IService1 = cf.CreateChannel()

            'Invoke the GetPerson method on the service asynchronously. The signature is:
            'IAsyncResult BeginGetPerson(int personId, AsyncCallback callback, object state)
            channel.BeginGetPerson(4, AddressOf GetPersonCallback, channel)

        End Sub

        'Implement the callback. 
        Private Sub GetPersonCallback(ByVal asyncResult As IAsyncResult)
            Dim p As Person = (CType(asyncResult.AsyncState, IService1)).EndGetPerson(asyncResult)

            'Update the UI thread and its output with the result of the method call.
            uiThread.Post(AddressOf UpdateUI, p)

        End Sub

        'Update the result displayed for the GetPerson invocation.
        Private Sub UpdateUI(ByVal state As Object)
            Dim p As Person = CType(state, Person)
            resultPersonName.Text = "The name of the Person is: " & p.Name
            resultPersonAge.Text = "The age of the Person is: " & p.Age
        End Sub

    // This is an example of how to create a custom binding with a specified encoding and tansport,
    // and how to create and open a channel for the service endpoint configured with the custom binding.
    public partial class MainPage : UserControl
    {
        //Declare a separate UI thread.
        SynchronizationContext uiThread; 

        public MainPage()
        {
            InitializeComponent();
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {

            //Create a custom binding that uses HTTP and binary message encoding.
            var elements = new List<BindingElement>();
            elements.Add(new BinaryMessageEncodingBindingElement());
            elements.Add(new HttpTransportBindingElement());
            var binding = new CustomBinding(elements);

            //Create a channel factory for the service endpoint configured with the custom binding.
            var cf = new ChannelFactory<IService1>(binding, new EndpointAddress("https://localhost:10483/Service1.svc"));


            //Save the synchronized context for the UI thread.
            uiThread = SynchronizationContext.Current;

            //Open the channel.
            IService1 channel = cf.CreateChannel();

            //Invoke the GetPerson method on the service asynchronously. The signature is:
            //IAsyncResult BeginGetPerson(int personId, AsyncCallback callback, object state)
            channel.BeginGetPerson(4, GetPersonCallback, channel);

        }

        //Implement the callback. 
        void GetPersonCallback(IAsyncResult asyncResult)
        {
            Person p = ((IService1)asyncResult.AsyncState).EndGetPerson(asyncResult);

            //Update the UI thread and its output with the result of the method call.
            uiThread.Post(UpdateUI, p);

        }

        //Update the result displayed for the GetPerson invocation.
        private void UpdateUI(object state)
        {
            Person p = (Person)state;
            resultPersonName.Text = "The name of the Person is: " + p.Name;
            resultPersonAge.Text = "The age of the Person is: " + p.Age;
        }

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