Class Connection

Namespace

NuGet.Protocol.Plugins

Assembly

NuGet.Protocol.dll

public sealed class Connection : IConnection, IDisposable

Inheritance

object

Connection

Implements

IConnection

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

JsonExtensions.ToJson(object, Formatting)

JsonExtensions.ToJToken(object)

Constructors

Connection(IMessageDispatcher, ISender, IReceiver, ConnectionOptions)

public Connection(IMessageDispatcher dispatcher, ISender sender, IReceiver receiver, ConnectionOptions options)

Parameters

dispatcher IMessageDispatcher

sender ISender

receiver IReceiver

options ConnectionOptions

Properties

MessageDispatcher

public IMessageDispatcher MessageDispatcher { get; }

Property Value

IMessageDispatcher

Options

public ConnectionOptions Options { get; }

Property Value

ConnectionOptions

ProtocolVersion

public SemanticVersion ProtocolVersion { get; }

Property Value

SemanticVersion

State

public ConnectionState State { get; }

Property Value

ConnectionState

Methods

Close()

public void Close()

ConnectAsync(CancellationToken)

public Task ConnectAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

SendAsync(Message, CancellationToken)

public Task SendAsync(Message message, CancellationToken cancellationToken)

Parameters

message Message

cancellationToken CancellationToken

Returns

Task

SendRequestAndReceiveResponseAsync<TOutbound, TInbound>(MessageMethod, TOutbound, CancellationToken)

public Task<TInbound> SendRequestAndReceiveResponseAsync<TOutbound, TInbound>(MessageMethod method, TOutbound payload, CancellationToken cancellationToken) where TOutbound : class where TInbound : class

Parameters

method MessageMethod

payload TOutbound

cancellationToken CancellationToken

Returns

Task<TInbound>

Type Parameters

TOutbound

TInbound

Events

Faulted

public event EventHandler<ProtocolErrorEventArgs> Faulted

Event Type

EventHandler<ProtocolErrorEventArgs>

MessageReceived

public event EventHandler<MessageEventArgs> MessageReceived

Event Type

EventHandler<MessageEventArgs>