Skip to content

Commit 070a44d

Browse files
stephentoubstephentoub
committed
Add System.Formats.Sse
1 parent 19467dc commit 070a44d

File tree

12 files changed

+1814
-0
lines changed

12 files changed

+1814
-0
lines changed

‎src/libraries/System.Formats.Sse/System.Formats.Sse.sln‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.11.34910.147
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Formats.Sse", "ref\System.Formats.Sse.csproj", "{ACB7E0BF-015F-43DC-A2F5-85506173B223}"
7+
EndProject
8+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Formats.Sse", "src\System.Formats.Sse.csproj", "{ACDB56AF-7B9F-4762-9764-D6FF09118D09}"
9+
EndProject
10+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.Formats.Sse.Tests", "tests\System.Formats.Sse.Tests.csproj", "{804B5D44-05A3-491E-A6AB-35C592E6703E}"
11+
EndProject
12+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{2BD73108-47D7-40E6-BFCB-169E6AD42A81}"
13+
EndProject
14+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ref", "ref", "{E6AF8CEE-6550-4190-97D4-D51C5B114919}"
15+
EndProject
16+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{D908DCBE-EFA4-4CCA-9A1C-AEB48D59C504}"
17+
EndProject
18+
Global
19+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
20+
Debug|Any CPU = Debug|Any CPU
21+
Release|Any CPU = Release|Any CPU
22+
EndGlobalSection
23+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
24+
{ACB7E0BF-015F-43DC-A2F5-85506173B223}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
25+
{ACB7E0BF-015F-43DC-A2F5-85506173B223}.Debug|Any CPU.Build.0 = Debug|Any CPU
26+
{ACB7E0BF-015F-43DC-A2F5-85506173B223}.Release|Any CPU.ActiveCfg = Release|Any CPU
27+
{ACB7E0BF-015F-43DC-A2F5-85506173B223}.Release|Any CPU.Build.0 = Release|Any CPU
28+
{ACDB56AF-7B9F-4762-9764-D6FF09118D09}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
29+
{ACDB56AF-7B9F-4762-9764-D6FF09118D09}.Debug|Any CPU.Build.0 = Debug|Any CPU
30+
{ACDB56AF-7B9F-4762-9764-D6FF09118D09}.Release|Any CPU.ActiveCfg = Release|Any CPU
31+
{ACDB56AF-7B9F-4762-9764-D6FF09118D09}.Release|Any CPU.Build.0 = Release|Any CPU
32+
{804B5D44-05A3-491E-A6AB-35C592E6703E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
33+
{804B5D44-05A3-491E-A6AB-35C592E6703E}.Debug|Any CPU.Build.0 = Debug|Any CPU
34+
{804B5D44-05A3-491E-A6AB-35C592E6703E}.Release|Any CPU.ActiveCfg = Release|Any CPU
35+
{804B5D44-05A3-491E-A6AB-35C592E6703E}.Release|Any CPU.Build.0 = Release|Any CPU
36+
EndGlobalSection
37+
GlobalSection(SolutionProperties) = preSolution
38+
HideSolutionNode = FALSE
39+
EndGlobalSection
40+
GlobalSection(NestedProjects) = preSolution
41+
{ACB7E0BF-015F-43DC-A2F5-85506173B223} = {E6AF8CEE-6550-4190-97D4-D51C5B114919}
42+
{ACDB56AF-7B9F-4762-9764-D6FF09118D09} = {D908DCBE-EFA4-4CCA-9A1C-AEB48D59C504}
43+
{804B5D44-05A3-491E-A6AB-35C592E6703E} = {2BD73108-47D7-40E6-BFCB-169E6AD42A81}
44+
EndGlobalSection
45+
GlobalSection(ExtensibilityGlobals) = postSolution
46+
SolutionGuid = {01DAF96B-AF8E-4576-A1BC-57D19BDB317E}
47+
EndGlobalSection
48+
EndGlobal

‎src/libraries/System.Formats.Sse/ref/System.Formats.Sse.cs‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
// ------------------------------------------------------------------------------
4+
// Changes to this file must follow the https://aka.ms/api-review process.
5+
// ------------------------------------------------------------------------------
6+
7+
namespace System.Formats.Sse
8+
{
9+
public sealed partial class SseEnumerable<T> : System.Collections.Generic.IAsyncEnumerable<System.Formats.Sse.SseItem<T>>, System.Collections.Generic.IEnumerable<System.Formats.Sse.SseItem<T>>, System.Collections.IEnumerable
10+
{
11+
internal SseEnumerable() { }
12+
public string LastEventId { get { throw null; } }
13+
public System.TimeSpan ReconnectionInterval { get { throw null; } }
14+
public System.Collections.Generic.IAsyncEnumerator<System.Formats.Sse.SseItem<T>> GetAsyncEnumerator(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
15+
public System.Collections.Generic.IEnumerator<System.Formats.Sse.SseItem<T>> GetEnumerator() { throw null; }
16+
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { throw null; }
17+
}
18+
public delegate T SseItemParser<out T>(string eventType, System.ReadOnlySpan<byte> data);
19+
public readonly partial struct SseItem<T>
20+
{
21+
private readonly T _Data_k__BackingField;
22+
private readonly object _dummy;
23+
private readonly int _dummyPrimitive;
24+
public SseItem(T data, string eventType) { throw null; }
25+
public T Data { get { throw null; } }
26+
public string EventType { get { throw null; } }
27+
}
28+
public static partial class SseParser
29+
{
30+
public static System.Formats.Sse.SseEnumerable<string> Parse(System.IO.Stream sseStream) { throw null; }
31+
public static System.Formats.Sse.SseEnumerable<T> Parse<T>(System.IO.Stream sseStream, System.Formats.Sse.SseItemParser<T> itemParser) { throw null; }
32+
}
33+
}

‎src/libraries/System.Formats.Sse/ref/System.Formats.Sse.csproj‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppPrevious);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>
5+
</PropertyGroup>
6+
7+
<ItemGroup>
8+
<Compile Include="System.Formats.Sse.cs" />
9+
</ItemGroup>
10+
11+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
12+
<PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />
13+
<ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Bcl.AsyncInterfaces\ref\Microsoft.Bcl.AsyncInterfaces.csproj" />
14+
</ItemGroup>
15+
16+
</Project>

‎src/libraries/System.Formats.Sse/src/PACKAGE.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## About
2+
3+
<!-- A description of the package and where one can find more documentation -->
4+
5+
System.Formats.Sse introduces the `SseParser` type, which provides factory methods for creating enumerables of the events in a stream of server-sent events (SSE).
6+
7+
## Key Features
8+
9+
<!-- The key features of this package -->
10+
11+
* Parser for server-sent events (SSE)
12+
13+
## How to Use
14+
15+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
16+
17+
Asynchronously parsing event contents as strings
18+
19+
```csharp
20+
using HttpClient client = new();
21+
using Stream response = await client.GetStreamAsync("https://localhost:12345/sse");
22+
await foreach (SseItem<string> item in SseParser.Parse(response))
23+
{
24+
Console.WriteLine(item.Data);
25+
}
26+
```
27+
28+
Synchronously parsing event contents as JSON
29+
30+
```csharp
31+
MemoryStream stream = new MemoryStream(data);
32+
foreach (SseItem<Book> item in SseParser.Parse(response, (eventType, bytes) => JsonSerializer.Deserialize<Book>(bytes)))
33+
{
34+
Console.WriteLine(item.Author);
35+
}
36+
```
37+
38+
## Main Types
39+
40+
<!-- The main types provided in this library -->
41+
42+
The main types provided by this library are:
43+
44+
* `System.Formats.Sse.SseParser`
45+
46+
## Feedback & Contributing
47+
48+
<!-- How to provide feedback on this package and contribute to it -->
49+
50+
System.Formats.Sse is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).

‎src/libraries/System.Formats.Sse/src/Resources/Strings.resx‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="InvalidOperation_EnumerateOnlyOnce" xml:space="preserve">
121+
<value>The enumerable may be enumerated only once.</value>
122+
</data>
123+
<data name="InvalidOperation_InvalidStreamNegativeBytes" xml:space="preserve">
124+
<value>The Stream implementation is invalid, returning a negative number from a read operation.</value>
125+
</data>
126+
</root>

‎src/libraries/System.Formats.Sse/src/System.Formats.Sse.csproj‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppPrevious);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>
5+
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
6+
<UseCompilerGeneratedDocXmlFile>true</UseCompilerGeneratedDocXmlFile>
7+
<IsPackable>true</IsPackable>
8+
<PackageDescription>Provides a simple parser for server-sent events (SSE).
9+
10+
Commonly Used Types:
11+
System.Formats.Sse.SseParser</PackageDescription>
12+
13+
<!-- Disabling baseline validation since this is a brand new package.
14+
Once this package has shipped a stable version, the following line
15+
should be removed in order to re-enable validation. -->
16+
<DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>
17+
</PropertyGroup>
18+
19+
<ItemGroup>
20+
<Compile Include="System\Formats\Sse\SseEnumerable.cs" />
21+
<Compile Include="System\Formats\Sse\SseItem.cs" />
22+
<Compile Include="System\Formats\Sse\SseItemParser.cs" />
23+
<Compile Include="System\Formats\Sse\SseParser.cs" />
24+
</ItemGroup>
25+
26+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
27+
<ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Bcl.AsyncInterfaces\src\Microsoft.Bcl.AsyncInterfaces.csproj" />
28+
<PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />
29+
<PackageReference Include="System.Threading.Tasks.Extensions" Version="$(SystemThreadingTasksExtensionsVersion)" />
30+
</ItemGroup>
31+
32+
</Project>

0 commit comments

Comments
 (0)