Class ClientExtensions

Namespace

OneImlx.Terminal.Client.Extensions

Assembly

OneImlx.Terminal.Client.dll

Provides extension methods for interacting with terminal server over various network protocols.

public static class ClientExtensions

Inheritance

object

ClientExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

SendToTerminalAsync(TerminalGrpcRouterProtoClient, TerminalInputOutput, CancellationToken, JsonSerializerOptions?)

Sends a TerminalInputOutput object to a terminal server via a gRPC request.

public static Task<TerminalGrpcRouterProtoOutput> SendToTerminalAsync(this TerminalGrpcRouterProto.TerminalGrpcRouterProtoClient grpcClient, TerminalInputOutput input, CancellationToken cancellationToken, JsonSerializerOptions? serializeOptions = null)

Parameters

grpcClient TerminalGrpcRouterProto.TerminalGrpcRouterProtoClient

The gRPC client instance used to send the request.

input TerminalInputOutput

The TerminalInputOutput to be sent.

cancellationToken CancellationToken

A CancellationToken to observe while awaiting completion.

serializeOptions JsonSerializerOptions

The JsonSerializerOptions used to serialize the input. Defaults to null.

Returns

Task<TerminalGrpcRouterProtoOutput>

A task representing the asynchronous operation. The task result contains the TerminalGrpcRouterProtoOutput from the server.

SendToTerminalAsync(HttpClient, TerminalInputOutput, CancellationToken, JsonSerializerOptions?)

Sends a TerminalInputOutput object to a terminal server as an HTTP POST request.

public static Task<TerminalInputOutput?> SendToTerminalAsync(this HttpClient httpClient, TerminalInputOutput input, CancellationToken cancellationToken, JsonSerializerOptions? serializeOptions = null)

Parameters

httpClient HttpClient

The HttpClient instance used to send the request.

input TerminalInputOutput

The TerminalInputOutput to be sent.

cancellationToken CancellationToken

A CancellationToken to observe while awaiting completion.

serializeOptions JsonSerializerOptions

The JsonSerializerOptions used to serialize the input. Defaults to null.

Returns

Task<TerminalInputOutput>

A task representing the asynchronous operation.

Remarks

The HTTP POST request is sent to the endpoint oneimlx/terminal/httprouter on the server.

SendToTerminalAsync(TcpClient, TerminalInputOutput, byte, CancellationToken, JsonSerializerOptions?)

Sends a TerminalInputOutput object to a terminal server via a TCP connection.

public static Task SendToTerminalAsync(this TcpClient tcpClient, TerminalInputOutput input, byte inputDelimiter, CancellationToken cancellationToken, JsonSerializerOptions? serializeOptions = null)

Parameters

tcpClient TcpClient

The TcpClient instance used to send the message.

input TerminalInputOutput

The TerminalInputOutput to be sent.

inputDelimiter byte

The stream delimiter.

cancellationToken CancellationToken

A CancellationToken to observe while awaiting completion.

serializeOptions JsonSerializerOptions

The JsonSerializerOptions used to serialize the input. Defaults to null.

Returns

Task

A task representing the asynchronous operation.

SendToTerminalAsync(UdpClient, TerminalInputOutput, byte, IPEndPoint, CancellationToken, JsonSerializerOptions?)

Sends a TerminalInputOutput object to a terminal server via a UDP message.

public static Task SendToTerminalAsync(this UdpClient udpClient, TerminalInputOutput input, byte inputDelimiter, IPEndPoint remoteEndPoint, CancellationToken cancellationToken, JsonSerializerOptions? serializeOptions = null)

Parameters

udpClient UdpClient

The UdpClient instance used to send the message.

input TerminalInputOutput

The TerminalInputOutput to be sent.

inputDelimiter byte

The stream delimiter.

remoteEndPoint IPEndPoint

The IPEndPoint representing the remote server endpoint.

cancellationToken CancellationToken

A CancellationToken to observe while awaiting completion.

serializeOptions JsonSerializerOptions

The JsonSerializerOptions used to serialize the input. Defaults to null.

Returns

Task

A task representing the asynchronous operation.