Opal 1.0.4

.NET 6.0
There is a newer version of this package available.
See the version list below for details.
Install-Package Opal -Version 1.0.4
dotnet add package Opal --version 1.0.4
<PackageReference Include="Opal" Version="1.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Opal --version 1.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Opal, 1.0.4"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Opal as a Cake Addin
#addin nuget:?package=Opal&version=1.0.4

// Install Opal as a Cake Tool
#tool nuget:?package=Opal&version=1.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Opal on Nuget Opal build Last commit MIT

Opal

A client library for the Gemini protocol written for .NET 6

Features

  • Asynchronous and Synchronous requests
  • Typed Gemtext document handling
  • Event-based user input
  • Configurable redirect behavior
  • Optional client certificate support with creation and persistence
  • Optional TOFU semantics with persistent certificate caching
  • No external libraries (only uses what .NET provides)

Usage

Install the Nuget package

Install-Package Opal -Version 1.0.3

Create an instance of a client and make requests

// the default behavior is to automatically follow redirects and to persit 
// local and remote certificates to disk
var client = OpalClient.CreateNew(OpalOptions.Default);

var response = client.SendRequest("gemini.circumlunar.space");

if (response is GemtextResponse gmi)
{
  // the response body may accessed directly...
  using (var reader = new StreamReader(gmi.Body))
    Console.WriteLine(reader.ReadToEnd());
  
  // ... or as a collection of strongly-typed ILine objects
  foreach (var line in gmi.AsDocument())
  {
    if (line is LinkLine link)
      Console.WriteLine($"Found link to {link.Uri}");
     
    Console.WriteLine(line);
  }
}

Subscribe to events in order to control certain protocol features

var client = OpalClient.CreateNew(OpalOptions.Default);

// using the default configuration, this certificate will be saved to the disk and
// sent whenever this host asks for it
client.CertificateRequired += (_, e) =>
  e.Certificate = CertificateHelper.GenerateNew(TimeSpan.FromDays(100), "some person");

client.InputRequired += 
  (_, e) => 
  {
    Console.Write($"{e.Prompt}: ");
    e.Value = Console.ReadLine();
  };
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2 62 6/12/2022
1.1.1 51 6/6/2022
1.1.0 55 6/3/2022
1.0.4 56 5/28/2022
1.0.3 72 5/7/2022
1.0.2 71 5/6/2022
1.0.1 63 5/5/2022
1.0.0 56 5/4/2022