AsyncStreamingClientResult.CreateSse Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| CreateSse(PipelineResponse, Func<SseItem<BinaryData>,Boolean>, CancellationToken) |
Creates a result that parses raw server-sent events. |
| CreateSse<T>(PipelineResponse, SseItemParser<T>, Func<SseItem<BinaryData>,Boolean>, CancellationToken) |
Creates a result that parses server-sent events. |
CreateSse(PipelineResponse, Func<SseItem<BinaryData>,Boolean>, CancellationToken)
Creates a result that parses raw server-sent events.
public static System.ClientModel.AsyncStreamingClientResult<System.Net.ServerSentEvents.SseItem<BinaryData>> CreateSse(System.ClientModel.Primitives.PipelineResponse response, Func<System.Net.ServerSentEvents.SseItem<BinaryData>,bool>? isTerminal = default, System.Threading.CancellationToken operationCancellationToken = default);static member CreateSse : System.ClientModel.Primitives.PipelineResponse * Func<System.Net.ServerSentEvents.SseItem<BinaryData>, bool> * System.Threading.CancellationToken -> System.ClientModel.AsyncStreamingClientResult<System.Net.ServerSentEvents.SseItem<BinaryData>>Public Shared Function CreateSse (response As PipelineResponse, Optional isTerminal As Func(Of SseItem(Of BinaryData), Boolean) = Nothing, Optional operationCancellationToken As CancellationToken = Nothing) As AsyncStreamingClientResult(Of SseItem(Of BinaryData))Parameters
- response
- PipelineResponse
An established response containing the stream.
- isTerminal
- Func<SseItem<BinaryData>,Boolean>
An optional predicate identifying the terminal event. The terminal event is not returned. If provided, reaching the end of the stream before a terminal event throws InvalidDataException.
- operationCancellationToken
- CancellationToken
The cancellation token for the operation.
Returns
A one-shot asynchronous streaming result.
Applies to
CreateSse<T>(PipelineResponse, SseItemParser<T>, Func<SseItem<BinaryData>,Boolean>, CancellationToken)
Creates a result that parses server-sent events.
public static System.ClientModel.AsyncStreamingClientResult<System.Net.ServerSentEvents.SseItem<T>> CreateSse<T>(System.ClientModel.Primitives.PipelineResponse response, System.Net.ServerSentEvents.SseItemParser<T> itemParser, Func<System.Net.ServerSentEvents.SseItem<BinaryData>,bool>? isTerminal = default, System.Threading.CancellationToken operationCancellationToken = default);static member CreateSse : System.ClientModel.Primitives.PipelineResponse * System.Net.ServerSentEvents.SseItemParser<'T> * Func<System.Net.ServerSentEvents.SseItem<BinaryData>, bool> * System.Threading.CancellationToken -> System.ClientModel.AsyncStreamingClientResult<System.Net.ServerSentEvents.SseItem<'T>>Public Shared Function CreateSse(Of T) (response As PipelineResponse, itemParser As SseItemParser(Of T), Optional isTerminal As Func(Of SseItem(Of BinaryData), Boolean) = Nothing, Optional operationCancellationToken As CancellationToken = Nothing) As AsyncStreamingClientResult(Of SseItem(Of T))Type Parameters
- T
The type of data in each event.
Parameters
- response
- PipelineResponse
An established response containing the stream.
- itemParser
- SseItemParser<T>
The parser for each event payload.
- isTerminal
- Func<SseItem<BinaryData>,Boolean>
An optional predicate that receives each raw
SseItem<BinaryData> and identifies the terminal event from
its envelope and payload before
itemParser is invoked.
The terminal event is not returned. If provided, reaching the end of the
stream before a terminal event throws InvalidDataException.
- operationCancellationToken
- CancellationToken
The cancellation token for the operation.
Returns
A one-shot asynchronous streaming result.
