Interface IPeerCommunicationService

Namespace

NLightning.Domain.Node.Interfaces

Assembly

NLightning.Domain.dll

Interface for communication with a single peer.

public interface IPeerCommunicationService : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

IsConnected

Gets a value indicating whether the connection is established.

bool IsConnected { get; }

Property Value

bool

PeerCompactPubKey

Gets the peer's public key.

CompactPubKey PeerCompactPubKey { get; }

Property Value

CompactPubKey

Methods

Disconnect(Exception?)

Disconnects from the peer.

void Disconnect(Exception? exception = null)

Parameters

exception Exception

The exception that caused the disconnection, if any.

InitializeAsync(TimeSpan)

Initializes the communication with the peer.

Task InitializeAsync(TimeSpan networkTimeout)

Parameters

networkTimeout TimeSpan

The network timeout.

Returns

Task

A task that represents the asynchronous operation.

SendMessageAsync(IMessage, CancellationToken)

Sends a message to the peer.

Task SendMessageAsync(IMessage message, CancellationToken cancellationToken = default)

Parameters

message IMessage

The message to send.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A task that represents the asynchronous operation.

SendWarningAsync(WarningException, CancellationToken)

Sends a warning message to the peer.

Task SendWarningAsync(WarningException we, CancellationToken cancellationToken = default)

Parameters

we WarningException

The warning exception to send.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A task that represents the asynchronous operation.

Events

DisconnectEvent

Event raised when the peer is disconnected.

event EventHandler<Exception?>? DisconnectEvent

Event Type

EventHandler<Exception>

ExceptionRaised

Event raised when an exception occurs.

event EventHandler<Exception>? ExceptionRaised

Event Type

EventHandler<Exception>

MessageReceived

Event raised when a message is received from the peer.

event EventHandler<IMessage?> MessageReceived

Event Type

EventHandler<IMessage>