This topic has not yet been rated - Rate this topic

BinaryMessageEncodingBindingElement Class

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

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)
public sealed class BinaryMessageEncodingBindingElement : MessageEncodingBindingElement, 
	IWsdlExportExtension, IPolicyExportExtension

The BinaryMessageEncodingBindingElement type exposes the following members.

  Name Description
Public method Supported by Portable Class Library BinaryMessageEncodingBindingElement Initializes a new instance of the BinaryMessageEncodingBindingElement class.
Top
  Name Description
Public property MaxReadPoolSize Gets or sets the maximum number of XML readers that are allocated to a pool and are ready for use to process incoming messages.
Public property MaxSessionSize Gets or sets the maximum amount of memory available within a session for optimizing transmission procedures.
Public property MaxWritePoolSize Gets or sets the maximum number of XML writers that are allocated to a pool and are ready for use to process outgoing messages.
Public property Supported by Portable Class Library MessageVersion Gets or sets the SOAP message and WS-Addressing versions that are used or expected. (Overrides MessageEncodingBindingElement.MessageVersion.)
Public property ReaderQuotas Gets constraints on the complexity of XML messages that can be processed by endpoints configured with this binding element.
Top
  Name Description
Public method Supported by Portable Class Library 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).)
Public method BuildChannelListener<TChannel> Builds the channel listener on the service that accepts a specified type of channel for a specified context. (Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)
Public method Supported by Portable Class Library 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.)
Public method CanBuildChannelListener<TChannel> Returns a value that indicates whether the current binding can build a listener for a specified type of channel and context. (Overrides BindingElement.CanBuildChannelListener<TChannel>(BindingContext).)
Public method Supported by Portable Class Library Clone Creates a new BinaryMessageEncodingBindingElement object initialized from the current one. (Overrides BindingElement.Clone().)
Public method Supported by Portable Class Library 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().)
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetProperty<T> Returns a typed object requested, if present, from the appropriate layer in the binding element stack. (Overrides MessageEncodingBindingElement.GetProperty<T>(BindingContext).)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeMessageVersion Returns whether the SOAP message structure version should be serialized.
Public method ShouldSerializeReaderQuotas Returns whether the values of constraints placed on the complexity of SOAP message structure should be serialized.
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method IPolicyExportExtension.ExportPolicy Writes custom binary message encoding elements into the generated metadata for an endpoint.
Explicit interface implemetation Private method IWsdlExportExtension.ExportContract Writes custom binary message encoding elements into the generated WSDL for a contract.
Explicit interface implemetation Private method IWsdlExportExtension.ExportEndpoint Writes custom binary message encoding elements into the generated WSDL for an endpoint.
Top

Encoding is the process of transforming a message into a sequence of bytes. Decoding is the reverse process. includes three types of encoding for SOAP messages: Text, Binary and Message Transmission Optimization Mechanism (MTOM).

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 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.

For more information about the binding element that specifies messages are encoded using the MTOM message encoding, see MtomMessageEncodingBindingElement.

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


BinaryMessageEncodingBindingElement be = new BinaryMessageEncodingBindingElement();
be.MaxReadPoolSize = 16;
be.MaxSessionSize = 2048;
be.MaxWritePoolSize = 16;
be.MessageVersion = MessageVersion.Default;
XmlDictionaryReaderQuotas quotas = be.ReaderQuotas;

CustomBinding binding = new CustomBinding();
BindingParameterCollection bpCol = new BindingParameterCollection();
BindingContext context = new BindingContext(binding, bpCol);
be.BuildChannelFactory<IDuplexChannel>(context);

CustomBinding binding2 = new CustomBinding();
BindingParameterCollection bpCol2 = new BindingParameterCollection();
BindingContext context2 = new BindingContext(binding2, bpCol2);
be.BuildChannelListener<IDuplexChannel>(context2);

be.CanBuildChannelListener<IDuplexChannel>(context2);
BindingElement bindingElement = be.Clone();
MessageEncoderFactory mef = be.CreateMessageEncoderFactory();
MessageVersion mv = be.GetProperty<MessageVersion>(context);


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ