367 lines
25 KiB
XML
367 lines
25 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>System.Net.ServerSentEvents</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:System.Net.ServerSentEvents.SseParser`1">
|
|
<summary>Provides a parser for server-sent events information.</summary>
|
|
<typeparam name="T">Specifies the type of data parsed from an event.</typeparam>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1.CR">
|
|
<summary>Carriage Return.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1.LF">
|
|
<summary>Line Feed.</summary>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseParser`1.CRLF">
|
|
<summary>Carriage Return Line Feed.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1.DefaultArrayPoolRentSize">
|
|
<summary>The default size of an ArrayPool buffer to rent.</summary>
|
|
<remarks>Larger size used by default to minimize number of reads. Smaller size used in debug to stress growth/shifting logic.</remarks>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._stream">
|
|
<summary>The stream to be parsed.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._itemParser">
|
|
<summary>The parser delegate used to transform bytes into a <typeparamref name="T"/>.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._used">
|
|
<summary>Indicates whether the enumerable has already been used for enumeration.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._lineBuffer">
|
|
<summary>Buffer, either empty or rented, containing the data being read from the stream while looking for the next line.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._lineOffset">
|
|
<summary>The starting offset of valid data in <see cref="F:System.Net.ServerSentEvents.SseParser`1._lineBuffer"/>.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._lineLength">
|
|
<summary>The length of valid data in <see cref="F:System.Net.ServerSentEvents.SseParser`1._lineBuffer"/>, starting from <see cref="F:System.Net.ServerSentEvents.SseParser`1._lineOffset"/>.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._newlineIndex">
|
|
<summary>The index in <see cref="F:System.Net.ServerSentEvents.SseParser`1._lineBuffer"/> where a newline ('\r', '\n', or "\r\n") was found.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._lastSearchedForNewline">
|
|
<summary>The index in <see cref="F:System.Net.ServerSentEvents.SseParser`1._lineBuffer"/> of characters already checked for newlines.</summary>
|
|
<remarks>
|
|
This is to avoid O(LineLength^2) behavior in the rare case where we have long lines that are built-up over multiple reads.
|
|
We want to avoid re-checking the same characters we've already checked over and over again.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._eof">
|
|
<summary>Set when eof has been reached in the stream.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._dataBuffer">
|
|
<summary>Rented buffer containing buffered data for the next event.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._dataLength">
|
|
<summary>The length of valid data in <see cref="F:System.Net.ServerSentEvents.SseParser`1._dataBuffer"/>, starting from index 0.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._dataAppended">
|
|
<summary>Whether data has been appended to <see cref="F:System.Net.ServerSentEvents.SseParser`1._dataBuffer"/>.</summary>
|
|
<remarks>This can be different than <see cref="F:System.Net.ServerSentEvents.SseParser`1._dataLength"/> != 0 if empty data was appended.</remarks>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser`1._eventType">
|
|
<summary>The event type for the next event.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.#ctor(System.IO.Stream,System.Net.ServerSentEvents.SseItemParser{`0})">
|
|
<summary>Initialize the enumerable.</summary>
|
|
<param name="stream">The stream to parse.</param>
|
|
<param name="itemParser">The function to use to parse payload bytes into a <typeparamref name="T"/>.</param>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.Enumerate">
|
|
<summary>Gets an enumerable of the server-sent events from this parser.</summary>
|
|
<exception cref="T:System.InvalidOperationException">The parser has already been enumerated. Such an exception may propagate out of a call to <see cref="M:System.Collections.IEnumerator.MoveNext"/>.</exception>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.EnumerateAsync(System.Threading.CancellationToken)">
|
|
<summary>Gets an asynchronous enumerable of the server-sent events from this parser.</summary>
|
|
<param name="cancellationToken">The cancellation token to use to cancel the enumeration.</param>
|
|
<exception cref="T:System.InvalidOperationException">The parser has already been enumerated. Such an exception may propagate out of a call to <see cref="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync"/>.</exception>
|
|
<exception cref="T:System.OperationCanceledException">The enumeration was canceled. Such an exception may propagate out of a call to <see cref="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync"/>.</exception>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.GetNextSearchOffsetAndLength(System.Int32@,System.Int32@)">
|
|
<summary>Gets the next index and length with which to perform a newline search.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.ShiftOrGrowLineBufferIfNecessary">
|
|
<summary>
|
|
If there's no room remaining in the line buffer, either shifts the contents
|
|
left or grows the buffer in order to make room for the next read.
|
|
</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.ProcessLine(System.Net.ServerSentEvents.SseItem{`0}@,System.Int32@)">
|
|
<summary>Processes a complete line from the SSE stream.</summary>
|
|
<param name="sseItem">The parsed item if the method returns true.</param>
|
|
<param name="advance">How many characters to advance in the line buffer.</param>
|
|
<returns>true if an SSE item was successfully parsed; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseParser`1.LastEventId">
|
|
<summary>Gets the last event ID.</summary>
|
|
<remarks>This value is updated any time a new last event ID is parsed. It is not reset between SSE items.</remarks>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseParser`1.ReconnectionInterval">
|
|
<summary>Gets the reconnection interval.</summary>
|
|
<remarks>
|
|
If no retry event was received, this defaults to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>, and it will only
|
|
ever be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> in that situation. If a client wishes to retry, the server-sent
|
|
events specification states that the interval may then be decided by the client implementation and should be a
|
|
few seconds.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.ThrowIfNotFirstEnumeration">
|
|
<summary>Transitions the object to a used state, throwing if it's already been used.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.FillLineBuffer">
|
|
<summary>Reads data from the stream into the line buffer.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.FillLineBufferAsync(System.Threading.CancellationToken)">
|
|
<summary>Reads data asynchronously from the stream into the line buffer.</summary>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseParser`1.Utf8Bom">
|
|
<summary>Gets the UTF8 BOM.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.SkipBomIfPresent">
|
|
<summary>Called at the beginning of processing to skip over an optional UTF8 byte order mark.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser`1.GrowBuffer(System.Byte[]@,System.Int32)">
|
|
<summary>Grows the buffer, returning the existing one to the ArrayPool and renting an ArrayPool replacement.</summary>
|
|
</member>
|
|
<member name="T:System.Net.ServerSentEvents.SseItem`1">
|
|
<summary>Represents a server-sent event.</summary>
|
|
<typeparam name="T">Specifies the type of data payload in the event.</typeparam>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseItem`1.#ctor(`0,System.String)">
|
|
<summary>Initializes the server-sent event.</summary>
|
|
<param name="data">The event's payload.</param>
|
|
<param name="eventType">The event's type.</param>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseItem`1.Data">
|
|
<summary>Gets the event's payload.</summary>
|
|
</member>
|
|
<member name="P:System.Net.ServerSentEvents.SseItem`1.EventType">
|
|
<summary>Gets the event's type.</summary>
|
|
</member>
|
|
<member name="T:System.Net.ServerSentEvents.SseItemParser`1">
|
|
<summary>Encapsulates a method for parsing the bytes payload of a server-sent event.</summary>
|
|
<typeparam name="T">Specifies the type of the return value of the parser.</typeparam>
|
|
<param name="eventType">The event's type.</param>
|
|
<param name="data">The event's payload bytes.</param>
|
|
<returns>The parsed <typeparamref name="T"/>.</returns>
|
|
</member>
|
|
<member name="T:System.Net.ServerSentEvents.SseParser">
|
|
<summary>Provides a parser for parsing server-sent events.</summary>
|
|
</member>
|
|
<member name="F:System.Net.ServerSentEvents.SseParser.EventTypeDefault">
|
|
<summary>The default <see cref="P:System.Net.ServerSentEvents.SseItem`1.EventType"/> ("message") for an event that did not explicitly specify a type.</summary>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser.Create(System.IO.Stream)">
|
|
<summary>Creates a parser for parsing a <paramref name="sseStream"/> of server-sent events into a sequence of <see cref="T:System.Net.ServerSentEvents.SseItem`1"/> values.</summary>
|
|
<param name="sseStream">The stream containing the data to parse.</param>
|
|
<returns>
|
|
The enumerable of strings, which may be enumerated synchronously or asynchronously. The strings
|
|
are decoded from the UTF8-encoded bytes of the payload of each event.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="sseStream"/> is null.</exception>
|
|
<remarks>
|
|
This overload has behavior equivalent to calling <see cref="M:System.Net.ServerSentEvents.SseParser.Create``1(System.IO.Stream,System.Net.ServerSentEvents.SseItemParser{``0})"/> with a delegate
|
|
that decodes the data of each event using <see cref="P:System.Text.Encoding.UTF8"/>'s GetString method.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser.Create``1(System.IO.Stream,System.Net.ServerSentEvents.SseItemParser{``0})">
|
|
<summary>Creates a parser for parsing a <paramref name="sseStream"/> of server-sent events into a sequence of <see cref="T:System.Net.ServerSentEvents.SseItem`1"/> values.</summary>
|
|
<typeparam name="T">Specifies the type of data in each event.</typeparam>
|
|
<param name="sseStream">The stream containing the data to parse.</param>
|
|
<param name="itemParser">The parser to use to transform each payload of bytes into a data element.</param>
|
|
<returns>The enumerable, which may be enumerated synchronously or asynchronously.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="sseStream"/> is null.</exception>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="itemParser"/> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Net.ServerSentEvents.SseParser.Utf8GetString(System.ReadOnlySpan{System.Byte})">
|
|
<summary>Encoding.UTF8.GetString(bytes)</summary>
|
|
</member>
|
|
<member name="P:System.SR.InvalidOperation_EnumerateOnlyOnce">
|
|
<summary>The enumerable may be enumerated only once.</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
|
<summary>
|
|
Attribute used to indicate a source generator should create a function for marshalling
|
|
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
|
</summary>
|
|
<remarks>
|
|
This attribute is meaningless if the source generator associated with it is not enabled.
|
|
The current built-in source generator only supports C# and only supplies an implementation when
|
|
applied to static, partial, non-generic methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
|
</summary>
|
|
<param name="libraryName">Name of the library containing the import.</param>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
|
<summary>
|
|
Gets the name of the library containing the import.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
|
<summary>
|
|
Gets or sets the name of the entry point to be called.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
|
<summary>
|
|
Gets or sets how to marshal string arguments to the method.
|
|
</summary>
|
|
<remarks>
|
|
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
|
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
|
<summary>
|
|
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
|
</summary>
|
|
<remarks>
|
|
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
|
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
|
<summary>
|
|
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
|
on other platforms) before returning from the attributed method.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
|
<summary>
|
|
Specifies how strings should be marshalled for generated p/invokes
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
|
<summary>
|
|
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
|
<summary>
|
|
Use the platform-provided UTF-8 marshaller.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
|
<summary>
|
|
Use the platform-provided UTF-16 marshaller.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
|
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
|
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
|
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
|
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter may be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
|
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with the associated parameter name.</summary>
|
|
<param name="parameterName">
|
|
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
|
<summary>Gets the associated parameter name.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
|
<summary>Applied to a method that will never return under any circumstance.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
|
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified parameter value.</summary>
|
|
<param name="parameterValue">
|
|
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
|
the associated parameter matches this value.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
|
<summary>Gets the condition parameter value.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with a field or property member.</summary>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
|
<summary>Initializes the attribute with the list of field and property members.</summary>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
|
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
|
</param>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
|
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
|
</param>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|