MessageBody Class

 

The message body.

Namespace:   Microsoft.ConfigurationManagement.Messaging.Framework
Assembly:  Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

Inheritance Hierarchy

System.Object
  Microsoft.ConfigurationManagement.Messaging.Framework.MessageBody

Syntax

[SerializableAttribute]
public sealed class MessageBody : IDisposable, ISerializable
[SerializableAttribute]
public ref class MessageBody sealed : IDisposable, ISerializable
<SerializableAttribute>
Public NotInheritable Class MessageBody
    Implements IDisposable, ISerializable

Constructors

Name Description
System_CAPS_pubmethod MessageBody()

Initializes a new instance of the MessageBody class.

System_CAPS_pubmethod MessageBody(Byte[])

Initializes a new instance of the MessageBody class. The constructor builds a body from a raw byte stream

System_CAPS_pubmethod MessageBody(String)

Initializes a new instance of the MessageBody class.

Properties

Name Description
System_CAPS_pubproperty Payload

Gets or sets the message payload.

System_CAPS_pubproperty PayloadEncoding

Gets or sets the encoding for the payload. The default is UTF-16 (Unicode).

System_CAPS_pubproperty PayloadHasChanged

Indicates whether the payload has changed since the data was last read.

System_CAPS_pubproperty PayloadSize

Gets the size of the payload, in bytes.

System_CAPS_pubproperty PayloadStream

Gets the stream that contains the raw payload.

Methods

Name Description
System_CAPS_pubmethod Compress(Type)

Message body inline compression.

System_CAPS_pubmethod Compress<T>()

Compresses the payload by using a compressor.

System_CAPS_pubmethod CopyPayloadToStream(Stream)

Copies the payload to an existing stream.

System_CAPS_pubmethod Decompress(Type)

Message body inline decompression.

System_CAPS_pubmethod Decompress<T>()

Decompresses the payload using a compressor.

System_CAPS_pubmethod Dispose()

Implementation of IDisposable.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetObjectData(SerializationInfo, StreamingContext)

Controls object serialization.

System_CAPS_pubmethod GetRawPayload()

Gets the raw payload as a byte array. This is a copy of the internal payload; setting this method will not change the internal payload. To overwrite the internal payload, you must use SetRawPayload.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod SetPayloadFromStream(Stream)

Sets the payload from an existing stream.

System_CAPS_pubmethod SetPayloadFromStream(Stream, Int64)

Sets the payload from an existing stream.

System_CAPS_pubmethod SetRawPayload(Byte[])

Sets the raw payload.

System_CAPS_pubmethod StripUnicodeBom()

Strips the Unicode byte order mark (BOM) to the payload inline.

System_CAPS_pubmethod ToString()

Returns the message payload. (Overrides Object.ToString().)

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

Microsoft.ConfigurationManagement.Messaging.Framework Namespace

Return to top