Class DelegatingServiceJsonRpcDescriptor

Namespace

Microsoft.ServiceHub.Framework

Assembly

Microsoft.ServiceHub.Framework.dll

A delegating RPC descriptor for services that support JSON-RPC. By default this descriptor will delegate operations to the wrapped descriptor.

public abstract class DelegatingServiceJsonRpcDescriptor : ServiceJsonRpcDescriptor, IEquatable<ServiceJsonRpcDescriptor>

Inheritance

object

ServiceRpcDescriptor

ServiceJsonRpcDescriptor

DelegatingServiceJsonRpcDescriptor

Implements

IEquatable<ServiceJsonRpcDescriptor>

Inherited Members

ServiceJsonRpcDescriptor.Protocol

ServiceJsonRpcDescriptor.Formatter

ServiceJsonRpcDescriptor.MessageDelimiter

ServiceJsonRpcDescriptor.ExceptionStrategy

ServiceJsonRpcDescriptor.MultiplexingStreamOptions

ServiceJsonRpcDescriptor.AdditionalServiceInterfaces

ServiceJsonRpcDescriptor.DisplayName

ServiceJsonRpcDescriptor.AcceptProxyWithExtraInterfaces

ServiceJsonRpcDescriptor.ConstructLocalProxy<T>(T)

ServiceJsonRpcDescriptor.Equals(object)

ServiceJsonRpcDescriptor.WithMultiplexingStream(MultiplexingStream)

ServiceJsonRpcDescriptor.WithMultiplexingStream(MultiplexingStream.Options)

ServiceJsonRpcDescriptor.WithExceptionStrategy(ExceptionProcessing)

ServiceJsonRpcDescriptor.WithAcceptProxyWithExtraInterfaces(bool)

ServiceJsonRpcDescriptor.WithAdditionalServiceInterfaces(ImmutableArray<Type>?)

ServiceJsonRpcDescriptor.WithDisplayName(string)

ServiceJsonRpcDescriptor.Equals(ServiceJsonRpcDescriptor)

ServiceJsonRpcDescriptor.GetHashCode()

ServiceJsonRpcDescriptor.Clone()

ServiceRpcDescriptor.Moniker

ServiceRpcDescriptor.TraceSource

ServiceRpcDescriptor.MultiplexingStream

ServiceRpcDescriptor.JoinableTaskFactory

ServiceRpcDescriptor.ClientInterface

ServiceRpcDescriptor.ConstructRpc<T>(object, IDuplexPipe)

ServiceRpcDescriptor.ConstructRpc<T>(IDuplexPipe)

ServiceRpcDescriptor.ConstructRpc(object, IDuplexPipe)

ServiceRpcDescriptor.WithTraceSource(TraceSource)

ServiceRpcDescriptor.WithJoinableTaskFactory(JoinableTaskFactory)

ServiceRpcDescriptor.WithServiceMoniker(ServiceMoniker)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Default implementation of this class only delegates protected override methods and ConstructRpcConnection(IDuplexPipe) is not delegated intentionally. This allows derived classes to pick which protected methods they want to override and which ones to delegate while keeping default ConstructRpcConnection implementation.

This implementation will also ensure inner descriptor is updated with any changes settings such as multiplexing options, before ConstructRpcConnection(IDuplexPipe) is executed.

Constructors

DelegatingServiceJsonRpcDescriptor(DelegatingServiceJsonRpcDescriptor)

Initializes a new instance of the DelegatingServiceJsonRpcDescriptor class.

public DelegatingServiceJsonRpcDescriptor(DelegatingServiceJsonRpcDescriptor descriptor)

Parameters

descriptor DelegatingServiceJsonRpcDescriptor

Delegating descriptor to copy from.

DelegatingServiceJsonRpcDescriptor(ServiceJsonRpcDescriptor)

Initializes a new instance of the DelegatingServiceJsonRpcDescriptor class.

public DelegatingServiceJsonRpcDescriptor(ServiceJsonRpcDescriptor innerDescriptor)

Parameters

innerDescriptor ServiceJsonRpcDescriptor

The descriptor to delegate operations to.

Methods

ApplySettingsToInnerDescriptor()

Ensures that settings from the current instance are applied to delegated descriptor.

protected void ApplySettingsToInnerDescriptor()

Remarks

This is called by ConstructRpcConnection(IDuplexPipe) by default but if derived class overrides that method it should call this method to ensure settings are applied properly to the delegated descriptor.

ConstructRpcConnection(IDuplexPipe)

Establishes an RPC connection over an IDuplexPipe.

public override ServiceRpcDescriptor.RpcConnection ConstructRpcConnection(IDuplexPipe pipe)

Parameters

pipe IDuplexPipe

The pipe used to send and receive RPC messages.

Returns

ServiceRpcDescriptor.RpcConnection

An object representing the lifetime of the connection.

Remarks

Callers are expected to call ConstructRpcClient<T>() and/or AddLocalRpcTarget(object) on the result value before invoking StartListening() to begin the RPC session.

CreateConnection(JsonRpc)

Initializes a new instance of a ServiceJsonRpcDescriptor.JsonRpcConnection or derived type.

protected override ServiceJsonRpcDescriptor.JsonRpcConnection CreateConnection(JsonRpc jsonRpc)

Parameters

jsonRpc JsonRpc

The JsonRpc object that will have to be passed to JsonRpcConnection(JsonRpc).

Returns

ServiceJsonRpcDescriptor.JsonRpcConnection

The new instance of ServiceJsonRpcDescriptor.JsonRpcConnection.

CreateFormatter()

Initializes a new instance of IJsonRpcMessageFormatter for use in a new server or client.

protected override IJsonRpcMessageFormatter CreateFormatter()

Returns

IJsonRpcMessageFormatter

The new message formatter.

CreateHandler(IDuplexPipe, IJsonRpcMessageFormatter)

Initializes a new instance of IJsonRpcMessageHandler for use in a new server or client.

protected override IJsonRpcMessageHandler CreateHandler(IDuplexPipe pipe, IJsonRpcMessageFormatter formatter)

Parameters

pipe IDuplexPipe

The pipe the handler should use to send and receive messages.

formatter IJsonRpcMessageFormatter

The IJsonRpcMessageFormatter the handler should use to encode messages.

Returns

IJsonRpcMessageHandler

The new message handler.

CreateJsonRpc(IJsonRpcMessageHandler)

Initializes a new instance of JsonRpc for use in a new server or client.

protected override JsonRpc CreateJsonRpc(IJsonRpcMessageHandler handler)

Parameters

handler IJsonRpcMessageHandler

The message handler that the JsonRpc instance should use.

Returns

JsonRpc

The new JsonRpc.