Class RPCClient

Namespace

The.RPC

Assembly

Instagile.dll

Provides a client for making remote procedure calls (RPC) to an endpoint.

public class RPCClient

Inheritance

object

RPCClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RPCClient(IEndpoint, IAuthentication, RPCOptions, string, string)

public RPCClient(IEndpoint endpoint, IAuthentication authentication, RPCOptions options, string appVersion, string environmentName)

Parameters

endpoint IEndpoint

authentication IAuthentication

options RPCOptions

appVersion string

environmentName string

Fields

Timeout

public readonly TimeSpan Timeout

Field Value

TimeSpan

Methods

ConnectAsync(CallbackEnvironment, bool)

public Task<Response<KeyedConnectResult>> ConnectAsync(CallbackEnvironment environment, bool reuseExistingConnection)

Parameters

environment CallbackEnvironment

reuseExistingConnection bool

Returns

Task<Response<KeyedConnectResult>>

ExecuteHighLevelAsync<T, U>(AnonymousProcedure<T, U>, AnonymousEnvironment, T)

Call a remote procedure via the configured endpoint, handling retries and errors internally.

public Task<U> ExecuteHighLevelAsync<T, U>(AnonymousProcedure<T, U> proc, AnonymousEnvironment environment, T request) where T : notnull

Parameters

proc AnonymousProcedure<T, U>

The procedure to call.

environment AnonymousEnvironment

Common parameters.

request T

Procedure-specific parameters.

Returns

Task<U>

Procedure-specific result.

Type Parameters

T

The type of the request.

U

The type of the response.

Exceptions

SecurityException

Thrown when executing the procedure is not permitted.

RPCException

Thrown when unable to execute the procedure. Subtypes include ConnectionException and MessageNotEncryptedException.

ExecuteHighLevelAsync<T, U>(Procedure<T, U>, CallbackEnvironment, T)

Call an authenticated remote procedure via the configured endpoint, handling retries and errors internally.

public Task<U> ExecuteHighLevelAsync<T, U>(Procedure<T, U> proc, CallbackEnvironment environment, T request) where T : notnull

Parameters

proc Procedure<T, U>

The procedure to call.

environment CallbackEnvironment

Common parameters.

request T

Procedure-specific parameters.

Returns

Task<U>

Procedure-specific result.

Type Parameters

T

The type of the request.

U

The type of the response.

Exceptions

SecurityException

Thrown when executing the procedure is not permitted.

RPCException

Thrown when unable to execute the procedure. Subtypes include ConnectionException and MessageNotEncryptedException.

ExecuteLowLevelAsync<T, U>(AnonymousProcedure<T, U>, AnonymousEnvironment, T)

Call a remote procedure via the configured endpoint.

public Task<Response<U>> ExecuteLowLevelAsync<T, U>(AnonymousProcedure<T, U> proc, AnonymousEnvironment environment, T request) where T : notnull

Parameters

proc AnonymousProcedure<T, U>

The procedure to call.

environment AnonymousEnvironment

Common parameters.

request T

Procedure-specific parameters.

Returns

Task<Response<U>>

Response object containing a result or error information.

Type Parameters

T

The type of the request.

U

The type of the response.

ExecuteLowLevelAsync<T, U>(Procedure<T, U>, CallbackEnvironment, T)

Call an authenticated remote procedure via the configured endpoint.

public Task<Response<U>> ExecuteLowLevelAsync<T, U>(Procedure<T, U> proc, CallbackEnvironment environment, T request) where T : notnull

Parameters

proc Procedure<T, U>

The procedure to call.

environment CallbackEnvironment

Common parameters.

request T

Procedure-specific parameters.

Returns

Task<Response<U>>

Response object containing a result or error information.

Type Parameters

T

The type of the request.

U

The type of the response.

ResetSessionAsync(Identity)

Clear out any session state belonging to this identity.

public Task ResetSessionAsync(Identity identity)

Parameters

identity Identity

Returns

Task