Message Class
TOC
Collapse the table of content
Expand the table of content

Message Class

 

Represents the unit of communication between endpoints in a distributed environment.

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

System.Object
  System.ServiceModel.Channels.Message

[<AbstractClass>]
type Message = 
    class
        interface IDisposable
    end

NameDescription
System_CAPS_protmethodMessage()

Initializes a new instance of the Message class.

NameDescription
System_CAPS_pubpropertyHeaders

When overridden in a derived class, gets the headers of the message.

System_CAPS_protpropertyIsDisposed

Returns a value that indicates whether the Message is disposed.

System_CAPS_pubpropertyIsEmpty

Returns a value that indicates whether the Message is empty.

System_CAPS_pubpropertyIsFault

Gets a value that indicates whether this message generates any SOAP faults.

System_CAPS_pubpropertyProperties

When overridden in a derived class, gets a set of processing-level annotations to the message.

System_CAPS_pubpropertyState

Gets the current state of this Message.

System_CAPS_pubpropertyVersion

When overridden in a derived class, gets the SOAP version of the message.

NameDescription
System_CAPS_pubmethodBeginWriteBodyContents(XmlDictionaryWriter, AsyncCallback, Object)

Starts the asynchronous writing of the contents of the message body.

System_CAPS_pubmethodBeginWriteMessage(XmlDictionaryWriter, AsyncCallback, Object)

Starts the asynchronous writing of the entire message.

System_CAPS_pubmethodClose()

Closes the Message and releases any resources.

System_CAPS_pubmethodCreateBufferedCopy(Int32)

Stores an entire Message into a memory buffer for future access.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, FaultCode, String, Object, String)

Creates a message that contains a SOAP fault, a reason and the detail for the fault, a version and an action.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, FaultCode, String, String)

Creates a message that contains a SOAP fault, the reason for the fault, a version and an action.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, MessageFault, String)

Creates a message that contains a SOAP fault, a version and an action.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String)

Creates a message that contains a version and an action.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String, BodyWriter)

Creates a message with a body that consists of an array of bytes.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String, Object)

Creates a message with the specified version, action and body.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String, Object, XmlObjectSerializer)

Creates a message using the specified version, action, message body and serializer.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String, XmlDictionaryReader)

Creates a message with the specified version, action and body.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(MessageVersion, String, XmlReader)

Creates a message using the specified reader, action and version.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(XmlDictionaryReader, Int32, MessageVersion)

Creates a message using the specified reader, action and version.

System_CAPS_pubmethodSystem_CAPS_staticCreateMessage(XmlReader, Int32, MessageVersion)

Creates a message using the specified reader, action and version.

System_CAPS_pubmethodEndWriteBodyContents(IAsyncResult)

Ends the asynchronous writing of the contents of the message body.

System_CAPS_pubmethodEndWriteMessage(IAsyncResult)

Ends the asynchronous writing of the entire message.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBody<'T>()

Retrieves the body of this Message instance.

System_CAPS_pubmethodGetBody<'T>(XmlObjectSerializer)

Retrieves the body of this Message using the specified serializer.

System_CAPS_pubmethodGetBodyAttribute(String, String)

Retrieves the attributes of the message body.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetReaderAtBodyContents()

Gets the XML dictionary reader that accesses the body content of this message.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnBeginWriteBodyContents(XmlDictionaryWriter, AsyncCallback, Object)

Raises an event when the message starts writing the contents of the message body.

System_CAPS_protmethodOnBeginWriteMessage(XmlDictionaryWriter, AsyncCallback, Object)

Raises an event the writing of entire messages starts.

System_CAPS_protmethodOnBodyToString(XmlDictionaryWriter)

Called when the message body is converted to a string.

System_CAPS_protmethodOnClose()

Called when the message is closing.

System_CAPS_protmethodOnCreateBufferedCopy(Int32)

Called when a message buffer is created to store this message.

System_CAPS_protmethodOnEndWriteBodyContents(IAsyncResult)

Raises an event when writing of the contents of the message body ends.

System_CAPS_protmethodOnEndWriteMessage(IAsyncResult)

Raises an event when the writing of the entire message ends.

System_CAPS_protmethodOnGetBody<'T>(XmlDictionaryReader)

Called when the body of the message is retrieved.

System_CAPS_protmethodOnGetBodyAttribute(String, String)

Called when the attributes of the message body is retrieved.

System_CAPS_protmethodOnGetReaderAtBodyContents()

Called when an XML dictionary reader that accesses the body content of this message is retrieved.

System_CAPS_protmethodOnWriteBodyContents(XmlDictionaryWriter)

Called when the message body is written to an XML file.

System_CAPS_protmethodOnWriteMessage(XmlDictionaryWriter)

Called when the entire message is written to an XML file.

System_CAPS_protmethodOnWriteStartBody(XmlDictionaryWriter)

Called when the start body is written to an XML file.

System_CAPS_protmethodOnWriteStartEnvelope(XmlDictionaryWriter)

Called when the start envelope is written to an XML file.

System_CAPS_protmethodOnWriteStartHeaders(XmlDictionaryWriter)

Called when the start header is written to an XML file.

System_CAPS_pubmethodToString()

Returns a string that represents the current Message instance. (Overrides Object.ToString().)

System_CAPS_pubmethodWriteBody(XmlDictionaryWriter)

Writes the body element using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteBody(XmlWriter)

Serializes the message body using the specified XmlWriter.

System_CAPS_pubmethodWriteBodyContents(XmlDictionaryWriter)

Serializes the body content using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteMessage(XmlDictionaryWriter)

Serializes the entire message using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteMessage(XmlWriter)

Serializes the entire message using the specified XmlWriter.

System_CAPS_pubmethodWriteStartBody(XmlDictionaryWriter)

Serializes the start body of the message using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteStartBody(XmlWriter)

Serializes the start body of the message using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteStartEnvelope(XmlDictionaryWriter)

Serializes the start envelope using the specified XmlDictionaryWriter.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

Closes all the resources used by this message. This method cannot be inherited.

NameDescription
System_CAPS_pubmethodToHttpRequestMessage()

Creates a HttpRequestMessage instance from an Message instance. (Defined by MessageExtensionMethods.)

System_CAPS_pubmethodToHttpResponseMessage()

Creates a HttpResponseMessage instance from an Message instance. (Defined by MessageExtensionMethods.)

The Message class provides a means of communicating arbitrary information between a sender and a receiver on a network. It can be used to relay information, suggest or demand a course of action, or request data.

The structure of a Message object represents a SOAP envelope. It consists of two distinct parts: the message's body and an optional collection of headers, represented by the Headers class. The message content is application-defined data sent from a sender to a receiver. The message headers enable system and application extensibility to meet the changing requirements, because you can define code to manipulate and respond to specific headers. You can also define your own headers. Message headers are serialized or deserialized along with the contents of the message.

Messages are received and sent in particular formats. Support is provided for two formats: the standard text-based XML format and a binary-based XML format. The Message object can be used to represent both SOAP 1.1 and SOAP 1.2 envelopes. Note that an instance of Message is fixed upon creation and is bound to a specific SOAP version. The Version property represents the SOAP version of the message.

A Message object can be serialized to an external store by using the WriteMessage method. Properties of the message can also be serialized, but they have to be individually identified and serialized separately. Deserializing a message to create an in-memory Message object can be done using CreateMessage. Properties must also be deserialized individually and manually added to the property collection for the specific Message instance.

The size of a Message object is fixed to the size of data it is transmitting. Every body is modeled as an instance of XmlReader, with no predefined limit on the size of the stream that the XmlReader instance is wrapping. However, specific channel providers can have a limit on the size of messages that they process.

A Message can be annotated with useful information generated by an entity that has examined and processed the message. This functionality is provided by the Headers and Properties properties. The Headers collection represents the set of SOAP headers on the message.

The Properties property represents the set of processing-level annotations on the message. Because information in headers is transmitted on the wire, an entity that examines a header must support the underlying version(s) of the protocols used by the header. However, properties provide a more version-independent way of annotating a message.

To create a Message instance, use one of the CreateMessage methods.

It is recommended that a consumer of a message always call Close when the consumer is finished accessing the contents of the message. This action frees finite system resources (for example, sockets, named pipes) that are tied to the lifetime of the message.

Special note for Managed C++ users deriving from this class:

  • Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • Avoid destructors: they cause the compiler to auto-generate IDisposable.

  • Avoid non-reference members: they can cause the compiler to auto-generate IDisposable.

  • Avoid finalizers; but if you include one, suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated IDisposable behavior.

Notes to Inheritors:

When you inherit from Message, you must override the following members: Headers, and Version.

The following code example shows a client that uses the channel factory to send a message and read the reply.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

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

Return to top
Show:
© 2016 Microsoft