Table of Contents

Interface IMessageChannelConnection

Namespace
Excalibur.Dispatch
Assembly
Excalibur.Dispatch.Abstractions.dll

Defines the connection lifecycle contract for a message channel.

public interface IMessageChannelConnection
Extension Methods

Properties

ChannelName

Gets the channel name or identifier.

string ChannelName { get; }

Property Value

string

The logical identifier of the channel.

IsConnected

Gets a value indicating whether the adapter is currently connected.

bool IsConnected { get; }

Property Value

bool

true when the adapter maintains an active connection; otherwise, false.

Methods

ConnectAsync(CancellationToken)

Connects to the channel.

Task ConnectAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task

A task that represents the asynchronous connect operation.

DisconnectAsync(CancellationToken)

Disconnects from the channel.

Task DisconnectAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task

A task that represents the asynchronous disconnect operation.