Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

MessageEncoder Class

The encoder is the component that is used to write messages to a stream and to read messages from a stream.

System.Object
  System.ServiceModel.Channels.MessageEncoder

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public abstract class MessageEncoder

The MessageEncoder type exposes the following members.

  NameDescription
Protected methodSupported by Silverlight for Windows PhoneMessageEncoderInitializes a new instance of the MessageEncoder class.
Top
  NameDescription
Public propertySupported by Silverlight for Windows PhoneContentTypeWhen overridden in a derived class, gets the MIME content type used by the encoder.
Public propertySupported by Silverlight for Windows PhoneMediaTypeWhen overridden in a derived class, gets the media type value that is used by the encoder.
Public propertySupported by Silverlight for Windows PhoneMessageVersionWhen overridden in a derived class, gets the message version value that is used by the encoder.
Top
  NameDescription
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the channel stack.
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneIsContentTypeSupportedReturns a value that indicates whether a specified message-level content-type value is supported by the message encoder.
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneReadMessage(ArraySegment<Byte>, BufferManager)When overridden in a derived class, reads a message from a specified buffer.
Public methodSupported by Silverlight for Windows PhoneReadMessage(Stream, Int32)When overridden in a derived class, reads a message from a specified stream.
Public methodSupported by Silverlight for Windows PhoneReadMessage(ArraySegment<Byte>, BufferManager, String)When overridden in a derived class, reads a message from a specified stream.
Public methodSupported by Silverlight for Windows PhoneReadMessage(Stream, Int32, String)When overridden in a derived class, reads a message from a specified stream.
Public methodSupported by Silverlight for Windows PhoneToStringReturns the content type that is used by the message encoder. (Overrides Object.ToString().)
Public methodSupported by Silverlight for Windows PhoneWriteMessage(Message, Stream)When overridden in a derived class, writes a message to a specified stream.
Public methodSupported by Silverlight for Windows PhoneWriteMessage(Message, Int32, BufferManager)Writes a message less than a specified size to a byte array buffer.
Public methodSupported by Silverlight for Windows PhoneWriteMessage(Message, Int32, BufferManager, Int32)When overridden in a derived class, writes a message of less than a specified size to a byte array buffer at the specified offset.
Top

MessageEncoder is a base class that provides implementations that support a Multipurpose Internet Mail Extensions (MIME) content type and message version, and defines the interface for the serialization and deserialization of messages according to that content type. Use it as a base class for writing your own custom encoder.

Use this class if you want to implement a custom message encoder. To implement your own custom message encoder, you must provide custom implementations of the following abstract base classes:

Override the Encoder to return an instance of your custom MessageEncoder. Then wire up your custom MessageEncoderFactory to the binding element stack used to configure the service or client by overriding the CreateMessageEncoderFactory method to return an instance of this factory.

The task of converting between the in-memory representation of a message and an XML Information Set (Infoset) representation that can be written to a stream is encapsulated within the MessageEncoder class, which most commonly serves as a factory for XML readers and XML writers that support specific types of XML encodings.

The key methods on MessageEncoder are WriteMessage() and ReadMessage(). WriteMessage() takes a Message object and writes it into a Stream object. ReadMessage() takes a Stream object and a maximum header size and returns a Message object.

The following code shows an example of a class that is derived from MessageEncoder.

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

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

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)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.