Interface IPinpointClient

Namespace

Acuit.Pinpoint.Services.Client

Assembly

Acuit.Pinpoint.Services.Client.dll

An Acuit Pinpoint service client.

public interface IPinpointClient : IDisposable

Inherited Members

IDisposable.Dispose()

Remarks

This abstraction exists to facilitate unit testing by enabling the use of mock implementations of Acuit Pinpoint service clients (specifically, with the ClientHelper methods).

Methods

Abort()

Causes the client to transition immediately from its current state into the closed state.

void Abort()

Remarks

This method indicates that any unfinished work should be ignored or ungracefully terminated before returning. The Abort() method can be used to cancel any outstanding operations, including outstanding calls to Close().

To gracefully transition a client from the Opened state to the Closed state call Close().

Close()

Causes the client to transition from its current state into the closed state.

void Close()

Remarks

This method causes a client to gracefully transition from the Opened state to the Closed state. The Close() method allows any unfinished work to be completed before returning (for example, finish sending any buffered messages).

The client enters the Closing state and remains in it until the transition to the Closed state is completed.

Close() returns once the Closed state is reached.

If the default close timeout elapses before the client is able to close gracefully, the client is aborted.

If Close() is called on a client in the Created, Opening, or Faulted state, the client is aborted. If Close() is called on a client in the Closing or Closed state, the call returns immediately.

Exceptions

CommunicationObjectFaultedException

Close() was called on a client in the Faulted state.

TimeoutException

The default close timeout elapsed before the client was able to close gracefully.