Share via


ServiceJsonRpcDescriptor<T> Class

Definition

An RPC descriptor for services that support JSON-RPC.

generic <typename T>
 where T : classpublic ref class ServiceJsonRpcDescriptor : Microsoft::ServiceHub::Framework::ServiceJsonRpcDescriptor
[System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")]
public class ServiceJsonRpcDescriptor<T> : Microsoft.ServiceHub.Framework.ServiceJsonRpcDescriptor where T : class
[<System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")>]
type ServiceJsonRpcDescriptor<'T (requires 'T : null)> = class
    inherit ServiceJsonRpcDescriptor
Public Class ServiceJsonRpcDescriptor(Of T)
Inherits ServiceJsonRpcDescriptor

Type Parameters

T

The RPC interface used to call the service.

Inheritance
Attributes

Constructors

ServiceJsonRpcDescriptor<T>(ServiceJsonRpcDescriptor<T>)

Initializes a new instance of the ServiceJsonRpcDescriptor<T> class and initializes all fields based on a template instance.

ServiceJsonRpcDescriptor<T>(ServiceMoniker, ServiceJsonRpcDescriptor+Formatters, ServiceJsonRpcDescriptor+MessageDelimiters)

Initializes a new instance of the ServiceJsonRpcDescriptor<T> class.

ServiceJsonRpcDescriptor<T>(ServiceMoniker, Type, ServiceJsonRpcDescriptor+Formatters, ServiceJsonRpcDescriptor+MessageDelimiters)

Initializes a new instance of the ServiceJsonRpcDescriptor<T> class.

Properties

ClientInterface

Gets the interface type that the client's "callback" RPC target is expected to implement.

(Inherited from ServiceRpcDescriptor)
ExceptionStrategy

Gets the way exceptions are communicated from the service to the client. This is set on the ExceptionStrategy property when the JsonRpc instance is created.

(Inherited from ServiceJsonRpcDescriptor)
Formatter

Gets the formatting used by the service.

(Inherited from ServiceJsonRpcDescriptor)
JoinableTaskFactory

Gets the JoinableTaskFactory that may be applied to the constructed RPC connection.

(Inherited from ServiceRpcDescriptor)
MessageDelimiter

Gets the mechanism by which message boundaries may be discerned. Some expected values are found in ServiceJsonRpcDescriptor.MessageDelimiters.

(Inherited from ServiceJsonRpcDescriptor)
Moniker

Gets the moniker for the service.

(Inherited from ServiceRpcDescriptor)
MultiplexingStream

Gets the Nerdbank.Streams.MultiplexingStream that may be used by constructed clients or servers.

(Inherited from ServiceRpcDescriptor)
MultiplexingStreamOptions

Gets the options to use when creating a new Nerdbank.Streams.MultiplexingStream as a prerequisite to establishing an RPC connection.

(Inherited from ServiceJsonRpcDescriptor)
Protocol

Gets a non-localized name of the protocol supported by this instance.

(Inherited from ServiceJsonRpcDescriptor)
TraceSource

Gets the TraceSource to be used on constructed clients or servers.

(Inherited from ServiceRpcDescriptor)

Methods

Clone()

Creates a copy of this instance with all the same properties.

ConstructLocalProxy<T>(T)

Wraps some target object with a proxy that gives the caller the similar semantics to calling an actual RPC object using JsonRpc.

(Inherited from ServiceJsonRpcDescriptor)
ConstructRpc(Object, IDuplexPipe)

Establishes an RPC connection to a given object over an IDuplexPipe, allowing the remote party to invoke methods locally on the given object.

(Inherited from ServiceRpcDescriptor)
ConstructRpc<T>(IDuplexPipe)

Creates an RPC client proxy over a given IDuplexPipe without providing a local RPC target for the remote party to invoke methods locally.

(Inherited from ServiceRpcDescriptor)
ConstructRpc<T>(Object, IDuplexPipe)

Creates an RPC client proxy over a given IDuplexPipe and provides a local RPC target for the remote party to invoke methods locally.

(Inherited from ServiceRpcDescriptor)
ConstructRpcConnection(IDuplexPipe)

Establishes an RPC connection over an IDuplexPipe.

(Inherited from ServiceJsonRpcDescriptor)
CreateConnection(JsonRpc)

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

(Inherited from ServiceJsonRpcDescriptor)
CreateFormatter()

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

(Inherited from ServiceJsonRpcDescriptor)
CreateHandler(IDuplexPipe, IJsonRpcMessageFormatter)

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

(Inherited from ServiceJsonRpcDescriptor)
CreateJsonRpc(IJsonRpcMessageHandler)

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

(Inherited from ServiceJsonRpcDescriptor)
Equals(Object) (Inherited from ServiceJsonRpcDescriptor)
Equals(ServiceJsonRpcDescriptor) (Inherited from ServiceJsonRpcDescriptor)
GetHashCode() (Inherited from ServiceJsonRpcDescriptor)
WithExceptionStrategy(ExceptionProcessing)

Returns an instance of ServiceJsonRpcDescriptor that resembles this one, but with the ExceptionStrategy property set to a new value.

(Inherited from ServiceJsonRpcDescriptor)
WithJoinableTaskFactory(JoinableTaskFactory)

Returns an instance of ServiceRpcDescriptor that resembles this one, but with the JoinableTaskFactory property set to the specified value.

(Inherited from ServiceRpcDescriptor)
WithMultiplexingStream(MultiplexingStream)

Returns an instance of ServiceRpcDescriptor that resembles this one, but with the MultiplexingStream property set to the specified value and Nerdbank.Streams.MultiplexingStream.Options set to null.

(Inherited from ServiceJsonRpcDescriptor)
WithMultiplexingStream(MultiplexingStream+Options)

Returns an instance of ServiceJsonRpcDescriptor that resembles this one, but with the MultiplexingStreamOptions property set to a frozen copy of the specified value. If a Nerdbank.Streams.MultiplexingStream has been set, it is cleared.

(Inherited from ServiceJsonRpcDescriptor)
WithServiceMoniker(ServiceMoniker)

Returns an instance of ServiceRpcDescriptor that resembles this one, but with the ServiceMoniker property set to the specified value.

(Inherited from ServiceRpcDescriptor)
WithTraceSource(TraceSource)

Returns an instance of ServiceRpcDescriptor that resembles this one, but with the TraceSource property set to the specified value.

(Inherited from ServiceRpcDescriptor)

Applies to