Share via


IRemoteServiceBroker.HandshakeAsync Method

Definition

Introduces the client to the server to detail the client's capabilities.

public System.Threading.Tasks.Task HandshakeAsync (Microsoft.ServiceHub.Framework.ServiceBrokerClientMetadata clientMetadata, System.Threading.CancellationToken cancellationToken = default);
abstract member HandshakeAsync : Microsoft.ServiceHub.Framework.ServiceBrokerClientMetadata * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function HandshakeAsync (clientMetadata As ServiceBrokerClientMetadata, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

clientMetadata
ServiceBrokerClientMetadata

The environment, capabilities and attributes of a client of the IRemoteServiceBroker.

cancellationToken
CancellationToken

A cancellation token.

Returns

A task representing this async call.

Exceptions

Thrown when this service broker does not support any of the supported service connection kinds that the client offered in SupportedConnections.

Applies to