Smdn.Net.EchonetLite.RouteB.Primitives 2.0.0-preview1

Smdn.Net.EchonetLite.RouteB.Primitives 2.0.0-preview1

Provides common types and abstractions for Smdn.Net.EchonetLite.RouteB.*.

Provides a transport layer abstraction class RouteBEchonetLiteHandler to handle ECHONET Lite communication via the route-B, the communication path for communicating information with smart electricity meters. Also provides an abstract interface IRouteBCredential to handle credentials used in B-route communication path.

Smdn.Net.EchonetLite.RouteB.*で共通して使用される型と抽象化機能を提供します。

スマート電力量メータとの情報伝達手段である「Bルート」を介してECHONET Lite規格の通信を扱うためのトランスポート層抽象クラスRouteBEchonetLiteHandlerを提供します。 また、その際に使用される認証情報を扱うための抽象インターフェイスIRouteBCredentialを提供します。

Contributing

This project welcomes contributions, feedbacks and suggestions. You can contribute to this project by submitting Issues or Pull Requests on the GitHub repository.

API List

List of APIs exposed by assembly Smdn.Net.EchonetLite.RouteB.Primitives-2.0.0-preview1 (net8.0)

// Smdn.Net.EchonetLite.RouteB.Primitives.dll (Smdn.Net.EchonetLite.RouteB.Primitives-2.0.0-preview1)
//   Name: Smdn.Net.EchonetLite.RouteB.Primitives
//   AssemblyVersion: 2.0.0.0
//   InformationalVersion: 2.0.0-preview1+60a8ce3520b765b1bcab669a662cfb615f41a1f5
//   TargetFramework: .NETCoreApp,Version=v8.0
//   Configuration: Release
//   Referenced assemblies:
//     Microsoft.Extensions.DependencyInjection.Abstractions, Version=6.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60
//     Smdn.Net.EchonetLite.Primitives, Version=2.0.0.0, Culture=neutral
//     System.Memory, Version=8.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
//     System.Net.Primitives, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
//     System.Runtime, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
#nullable enable annotations

using System;
using System.Buffers;
using System.Net;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Smdn.Net.EchonetLite.RouteB.Credentials;
using Smdn.Net.EchonetLite.RouteB.Transport;
using Smdn.Net.EchonetLite.Transport;

namespace Smdn.Net.EchonetLite.RouteB.Credentials {
  public interface IRouteBCredential : IDisposable {
    void WriteIdTo(IBufferWriter<byte> buffer);
    void WritePasswordTo(IBufferWriter<byte> buffer);
  }

  public interface IRouteBCredentialIdentity {
  }

  public interface IRouteBCredentialProvider {
    IRouteBCredential GetCredential(IRouteBCredentialIdentity identity);
  }

  public static class RouteBCredentials {
    public const int AuthenticationIdLength = 32;
    public const int PasswordLength = 12;
  }
}

namespace Smdn.Net.EchonetLite.RouteB.Transport {
  public interface IRouteBEchonetLiteHandlerBuilder {
    IServiceCollection Services { get; }
  }

  public interface IRouteBEchonetLiteHandlerFactory {
    ValueTask<RouteBEchonetLiteHandler> CreateAsync(CancellationToken cancellationToken);
  }

  public abstract class RouteBEchonetLiteHandler : EchonetLiteHandler {
    protected RouteBEchonetLiteHandler() {}

    public abstract IPAddress? PeerAddress { get; }

    public ValueTask ConnectAsync(IRouteBCredential credential, CancellationToken cancellationToken = default) {}
    protected abstract ValueTask ConnectAsyncCore(IRouteBCredential credential, CancellationToken cancellationToken);
    public ValueTask DisconnectAsync(CancellationToken cancellationToken = default) {}
    protected abstract ValueTask DisconnectAsyncCore(CancellationToken cancellationToken);
  }
}
// API list generated by Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks v1.4.1.0.
// Smdn.Reflection.ReverseGenerating.ListApi.Core v1.3.1.0 (https://github.com/smdn/Smdn.Reflection.ReverseGenerating)