Interface IClient

Represents a client that manages AMQP connection lifecycle and related producer/consumer/subscriber managers.

Inherited Members

IAsyncDisposable.DisposeAsync()

Namespace: CodersRealm.NmsAmqpClient

Assembly: CodersRealm.NmsAmqpClient.dll

Syntax

public interface IClient : IAsyncDisposable

Properties

ClientId

Gets the unique identifier for this client instance.

Declaration

string ClientId { get; }

Property Value

Type	Description
string

Consumers

Gets the manager responsible for creating and managing message consumers for queues.

Declaration

IConsumerManager Consumers { get; }

Property Value

Type	Description
IConsumerManager

See Also

IConsumerManager

IsConnected

Gets a bool value indicating whether the client currently has a active connection that has started and is open.

Declaration

bool IsConnected { get; }

Property Value

Type	Description
bool

Remarks

Note, it is possible for the connection to be lost and this flag to indicate true (or vise versa) until internal events are trigger that would enable the determination that the connection is closed or open.

IsDisposed

Gets a value indicating whether the client has been disposed.

Declaration

bool IsDisposed { get; }

Property Value

Type	Description
bool

IsStarted

Gets a value indicating whether the client has been started.

Declaration

bool IsStarted { get; }

Property Value

Type	Description
bool

Producers

Gets the manager responsible for creating and managing message producers.

Declaration

IProducerManager Producers { get; }

Property Value

Type	Description
IProducerManager

See Also

IProducerManager

Subscribers

Gets the manager responsible for creating and managing message subscribers for topics.

Declaration

ISubscriberManager Subscribers { get; }

Property Value

Type	Description
ISubscriberManager

See Also

ISubscriberManager

Methods

StartAsync()

Starts the client's connection asynchronously.

Declaration

Task StartAsync()

Returns

Type	Description
Task	A Task that completes when the connection has been established.

StartAsync(CancellationToken)

Starts the client's connection asynchronously and observes the provided cancellation token.

Declaration

Task StartAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token to observe while starting the connection.

Returns

Type	Description
Task	A Task that completes when the connection has been established or the operation is cancelled.