Scintillating.ProxyProtocol.Parser 0.6.0

dotnet add package Scintillating.ProxyProtocol.Parser --version 0.6.0
NuGet\Install-Package Scintillating.ProxyProtocol.Parser -Version 0.6.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Scintillating.ProxyProtocol.Parser" Version="0.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Scintillating.ProxyProtocol.Parser --version 0.6.0
#r "nuget: Scintillating.ProxyProtocol.Parser, 0.6.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Scintillating.ProxyProtocol.Parser as a Cake Addin
#addin nuget:?package=Scintillating.ProxyProtocol.Parser&version=0.6.0

// Install Scintillating.ProxyProtocol.Parser as a Cake Tool
#tool nuget:?package=Scintillating.ProxyProtocol.Parser&version=0.6.0

Scintillating.ProxyProtocol.Parser is a .NET library for parsing PROXY protocol headers.

Quickstart

  • The following example showcases how to use this library with PipeReader
  • Note that pipeReader.AdvanceTo should be only called once per read, so any additional reading should happen before it.

var cancellationToken = default(CancellationToken);
var pipe = new Pipe();
var pipeReader = pipe.Reader;
ProxyProtocolHeader? value = null;
var parser = new ProxyProtocolParser();
ReadResult readResult;
bool done = false;
do
{
    cancellationToken.ThrowIfCancellationRequested();
    readResult = await pipeReader.ReadAsync(cancellationToken)
        .ConfigureAwait(false);
    if (readResult.IsCanceled)
    {
        continue;
    }
    done = parser.TryParse(readResult.Buffer, out var advanceTo, out value);
    if (!done && readResult.IsCompleted)
    {
        throw new InvalidOperationException("Incomplete PROXY protocol header");
    }
    pipeReader.AdvanceTo(advanceTo.Consumed, advanceTo.Examined);
}
while (!done);
// use the value
_ = value;
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Scintillating.ProxyProtocol.Parser:

Package Downloads
Scintillating.ProxyProtocol.Middleware

ASP.NET Core middleware for HAProxy PROXY protocol (V1 and V2)

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.0 214 11/14/2023
0.5.0 2,403 8/25/2022
0.4.2 376 7/25/2022
0.4.1 396 6/13/2022
0.4.0 495 6/13/2022
0.3.1 606 4/27/2022
0.3.0 501 4/22/2022
0.2.2 500 4/5/2022
0.1.1 497 4/2/2022