S101Reader.Payload Property

S101ReaderPayload Property

Gets a NonSeekableStream instance that can be used to read the payload of the current message.

Namespace: Lawo.EmberPlusSharp.S101
Assembly: Lawo.EmberPlusSharp (in Lawo.EmberPlusSharp.dll) Version: 1.4.1707.27006

Syntax

Copy

public NonSeekableStream Payload { get; }

Property Value

Type: NonSeekableStream

Exceptions

Exception	Condition
InvalidOperationException	ReadAsync(CancellationToken) has never been called, or the last call to ReadAsync(CancellationToken) returned false or threw an exception, or the IsCompleted property is false for the Task object returned by a previously called async method.
ObjectDisposedException	DisposeAsync(CancellationToken) has been called.

Remarks

Call any of the Read methods on the returned NonSeekableStream object to obtain the payload.

If a message contains multiple packets, their payload is automatically joined such that it can be read through the returned stream as if the message consisted of only one packet.

If the current message does not have a payload or if the end of the payload has been reached, return values from Read method calls will indicate that the end of the stream has been reached.

Read methods of the returned Stream object will throw S101Exception to signal parsing errors, see Message for more information.

Reference

S101Reader Class

Lawo.EmberPlusSharp.S101 Namespace