Windows Dev Center

BinaryMessageEncodingBindingElement Class

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

Namespace:  System.ServiceModel.Channels
Assemblies:   System.ServiceModel (in System.ServiceModel.dll)
  System.ServiceModel.Primitives (in System.ServiceModel.Primitives.dll)

public sealed class BinaryMessageEncodingBindingElement : MessageEncodingBindingElement, 
	IWsdlExportExtension, IPolicyExportExtension

The BinaryMessageEncodingBindingElement type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryBinaryMessageEncodingBindingElementInitializes a new instance of the BinaryMessageEncodingBindingElement class.
Top

  NameDescription
Public propertyCompressionFormatGets or sets the compression format for the binding element.
Public propertyMaxReadPoolSizeGets or sets the maximum number of XML readers that are allocated to a pool and are ready for use to process incoming messages.
Public propertyMaxSessionSizeGets or sets the maximum amount of memory available within a session for optimizing transmission procedures.
Public propertyMaxWritePoolSizeGets or sets the maximum number of XML writers that are allocated to a pool and are ready for use to process outgoing messages.
Public propertySupported by Portable Class LibraryMessageVersionGets or sets the SOAP message and WS-Addressing versions that are used or expected. (Overrides MessageEncodingBindingElement.MessageVersion.)
Public propertyReaderQuotasGets constraints on the complexity of XML messages that can be processed by endpoints configured with this binding element.
Top

  NameDescription
Public methodSupported by Portable Class LibraryBuildChannelFactory<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 methodBuildChannelListener<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 methodSupported by Portable Class LibraryCanBuildChannelFactory<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 methodCanBuildChannelListener<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 methodSupported by Portable Class LibraryCloneCreates a new BinaryMessageEncodingBindingElement object initialized from the current one. (Overrides BindingElement.Clone().)
Public methodSupported by Portable Class LibraryCreateMessageEncoderFactoryCreates 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 methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the binding element stack. (Overrides MessageEncodingBindingElement.GetProperty<T>(BindingContext).)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodShouldSerializeMessageVersionReturns whether the SOAP message structure version should be serialized.
Public methodShouldSerializeReaderQuotasReturns whether the values of constraints placed on the complexity of SOAP message structure should be serialized.
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIPolicyExportExtension.ExportPolicyWrites a custom binary message encoding elements into the generated metadata for an endpoint.
Explicit interface implemetationPrivate methodIWsdlExportExtension.ExportContractWrites a custom binary message encoding elements into the generated WSDL for a contract.
Explicit interface implemetationPrivate methodIWsdlExportExtension.ExportEndpointWrites a 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. Windows Communication Foundation (WCF) 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.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library

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