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 | |
---|---|---|
MessageBody() | Initializes a new instance of the MessageBody class. |
|
MessageBody(Byte[]) | Initializes a new instance of the MessageBody class. The constructor builds a body from a raw byte stream |
|
MessageBody(String) | Initializes a new instance of the MessageBody class. |
Properties
Name | Description | |
---|---|---|
Payload | Gets or sets the message payload. |
|
PayloadEncoding | Gets or sets the encoding for the payload. The default is UTF-16 (Unicode). |
|
PayloadHasChanged | Indicates whether the payload has changed since the data was last read. |
|
PayloadSize | Gets the size of the payload, in bytes. |
|
PayloadStream | Gets the stream that contains the raw payload. |
Methods
Name | Description | |
---|---|---|
Compress(Type) | Message body inline compression. |
|
Compress<T>() | Compresses the payload by using a compressor. |
|
CopyPayloadToStream(Stream) | Copies the payload to an existing stream. |
|
Decompress(Type) | Message body inline decompression. |
|
Decompress<T>() | Decompresses the payload using a compressor. |
|
Dispose() | Implementation of IDisposable. |
|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetObjectData(SerializationInfo, StreamingContext) | Controls object serialization. |
|
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. |
|
GetType() | (Inherited from Object.) |
|
SetPayloadFromStream(Stream) | Sets the payload from an existing stream. |
|
SetPayloadFromStream(Stream, Int64) | Sets the payload from an existing stream. |
|
SetRawPayload(Byte[]) | Sets the raw payload. |
|
StripUnicodeBom() | Strips the Unicode byte order mark (BOM) to the payload inline. |
|
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