| S101ReaderReadAsync Method |  |
Asynchronously reads the next message.
Namespace: Lawo.EmberPlusSharp.S101
Assembly: Lawo.EmberPlusSharp (in Lawo.EmberPlusSharp.dll) Version: 1.4.1707.27006
SyntaxC#
public Task<bool> ReadAsync( CancellationToken cancellationToken )
Parameters
- cancellationToken
- Type: System.ThreadingCancellationToken
Return Value
Type: TaskBooleantrue if the next message was read successfully; false if there are no more messages to read.
Exceptions| Exception | Condition |
|---|---|
| Exception | An exception was thrown from the callback passed to the constructor, see Message for more information. |
| InvalidOperationException | The IsCompleted property is false for the Task object returned by a previously called async method. |
| ObjectDisposedException | DisposeAsync(CancellationToken) has been called. |
| S101Exception | An error occurred while parsing the S101-encoded data, see Message for more information. |
RemarksWhen a S101Reader is first created and initialized, there is no information available. You must call ReadAsync(CancellationToken) to read the first message.
Possibly unread payload of the previous message is automatically skipped.
See Also