More...

Inheritance diagram for Tgstation.Server.Client.RestServerClient:

[legend]

Collaboration diagram for Tgstation.Server.Client.RestServerClient:

[legend]

Public Member Functions

RestServerClient (IApiClient apiClient)

Initializes a new instance of the RestServerClient class.

ValueTask DisposeAsync ()

ValueTask< ServerInformationResponse > ServerInformation (CancellationToken cancellationToken)

The ServerInformationResponse of the IRestServerClient.

Parameters

cancellationToken The CancellationToken for the operation.

Returns: A Task<TResult> resulting in the ServerInformationResponse of the target server.

void AddRequestLogger (IRequestLogger requestLogger)

Adds a requestLogger to the request pipeline.

Parameters

requestLogger The IRequestLogger to add.

ValueTask< IAsyncDisposable > SubscribeToJobUpdates (IJobsHub jobsReceiver, IRetryPolicy? retryPolicy, Action< ILoggingBuilder >? loggingConfigureAction, CancellationToken cancellationToken)

Subscribe to all job updates available to the IRestServerClient.

Parameters

jobsReceiver	The IJobsHub to use to subscribe to updates.
retryPolicy	The optional IRetryPolicy to use for the backing connection. The default retry policy waits for 1, 2, 4, 8, and 16 seconds, then 30s repeatedly.
loggingConfigureAction	The optional Action<T1> used to configure a ILoggingBuilder.
cancellationToken	The CancellationToken for the operation.

Returns: An IAsyncDisposable representing the lifetime of the subscription.

Properties
Uri	Url `[get]`
	The connected server's root Uri.

TokenResponse	Token `[get, set]`
	The Token used to access the server.

TimeSpan	Timeout `[get, set]`
	The connection timeout.

IInstanceManagerClient	Instances `[get]`
	Access the IInstanceManagerClient.

IAdministrationClient	Administration `[get]`
	Access the IAdministrationClient.

IUsersClient	Users `[get]`
	Access the IUsersClient.

IUserGroupsClient	Groups `[get]`
	Access the IUserGroupsClient.

ITransferClient	Transfer `[get]`
	Access the ITransferClient.Most client methods handle transfers in their invocations. There is rarely any reason to use the ITransferClient directly.

Properties inherited from Tgstation.Server.Client.IRestServerClient

Private Attributes
readonly IApiClient	apiClient
	The IApiClient for the RestServerClient.

Detailed Description

Definition at line 15 of file RestServerClient.cs.

Constructor & Destructor Documentation

◆ RestServerClient()

Tgstation.Server.Client.RestServerClient.RestServerClient ( IApiClient apiClient )

Initializes a new instance of the RestServerClient class.

Parameters

apiClient The value of apiClient.

Definition at line 58 of file RestServerClient.cs.

        {
            this.apiClient = apiClient ?? throw new ArgumentNullException(nameof(apiClient));
 
            Instances = new InstanceManagerClient(apiClient);
            Users = new UsersClient(apiClient);
            Administration = new AdministrationClient(apiClient);
            Groups = new UserGroupsClient(apiClient);
        }

References Tgstation.Server.Client.RestServerClient.Administration, Tgstation.Server.Client.RestServerClient.apiClient, Tgstation.Server.Client.RestServerClient.Groups, Tgstation.Server.Client.RestServerClient.Instances, and Tgstation.Server.Client.RestServerClient.Users.

Member Function Documentation

◆ AddRequestLogger()

void Tgstation.Server.Client.RestServerClient.AddRequestLogger ( IRequestLogger requestLogger )

Adds a requestLogger to the request pipeline.

Parameters

requestLogger The IRequestLogger to add.

Implements Tgstation.Server.Client.IRestServerClient.

◆ DisposeAsync()

ValueTask Tgstation.Server.Client.RestServerClient.DisposeAsync ( )

◆ ServerInformation()

ValueTask< ServerInformationResponse > Tgstation.Server.Client.RestServerClient.ServerInformation ( CancellationToken cancellationToken )

The ServerInformationResponse of the IRestServerClient.

Parameters

cancellationToken The CancellationToken for the operation.

Returns: A Task<TResult> resulting in the ServerInformationResponse of the target server.

Implements Tgstation.Server.Client.IRestServerClient.

◆ SubscribeToJobUpdates()

ValueTask< IAsyncDisposable > Tgstation.Server.Client.RestServerClient.SubscribeToJobUpdates	(	IJobsHub	jobsReceiver,
		IRetryPolicy?	retryPolicy,
		Action< ILoggingBuilder >?	loggingConfigureAction,
		CancellationToken	cancellationToken
	)

Subscribe to all job updates available to the IRestServerClient.

Parameters

jobsReceiver	The IJobsHub to use to subscribe to updates.
retryPolicy	The optional IRetryPolicy to use for the backing connection. The default retry policy waits for 1, 2, 4, 8, and 16 seconds, then 30s repeatedly.
loggingConfigureAction	The optional Action<T1> used to configure a ILoggingBuilder.
cancellationToken	The CancellationToken for the operation.

Returns: An IAsyncDisposable representing the lifetime of the subscription.

Implements Tgstation.Server.Client.IRestServerClient.

Member Data Documentation

◆ apiClient

readonly IApiClient Tgstation.Server.Client.RestServerClient.apiClient

private

The IApiClient for the RestServerClient.

Definition at line 52 of file RestServerClient.cs.

Referenced by Tgstation.Server.Client.RestServerClient.RestServerClient().

Property Documentation

◆ Administration

IAdministrationClient Tgstation.Server.Client.RestServerClient.Administration

get

Access the IAdministrationClient.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 38 of file RestServerClient.cs.

38{ get; }

Referenced by Tgstation.Server.Client.RestServerClient.RestServerClient().

◆ Groups

IUserGroupsClient Tgstation.Server.Client.RestServerClient.Groups

get

Access the IUserGroupsClient.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 44 of file RestServerClient.cs.

44{ get; }

Referenced by Tgstation.Server.Client.RestServerClient.RestServerClient().

◆ Instances

IInstanceManagerClient Tgstation.Server.Client.RestServerClient.Instances

get

Access the IInstanceManagerClient.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 35 of file RestServerClient.cs.

35{ get; }

Referenced by Tgstation.Server.Client.RestServerClient.RestServerClient().

◆ Timeout

TimeSpan Tgstation.Server.Client.RestServerClient.Timeout

getset

The connection timeout.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 28 of file RestServerClient.cs.

        {
            get => apiClient.Timeout;
            set => apiClient.Timeout = value;
        }

◆ Token

TokenResponse Tgstation.Server.Client.RestServerClient.Token

getset

The Token used to access the server.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 21 of file RestServerClient.cs.

        {
            get => apiClient.Headers.Token ?? throw new InvalidOperationException("apiClient.Headers.Token was null!");
            set => apiClient.Headers = new ApiHeaders(apiClient.Headers.UserAgent!, value);
        }

◆ Transfer

ITransferClient Tgstation.Server.Client.RestServerClient.Transfer

get

Access the ITransferClient.Most client methods handle transfers in their invocations. There is rarely any reason to use the ITransferClient directly.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 47 of file RestServerClient.cs.

◆ Url

Uri Tgstation.Server.Client.RestServerClient.Url

get

The connected server's root Uri.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 18 of file RestServerClient.cs.

◆ Users

IUsersClient Tgstation.Server.Client.RestServerClient.Users

get

Access the IUsersClient.

Implements Tgstation.Server.Client.IRestServerClient.

Definition at line 41 of file RestServerClient.cs.

41{ get; }

Referenced by Tgstation.Server.Client.RestServerClient.RestServerClient().

The documentation for this class was generated from the following file:

src/Tgstation.Server.Client/RestServerClient.cs

Public Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RestServerClient()

Member Function Documentation

◆ AddRequestLogger()

◆ DisposeAsync()

◆ ServerInformation()

◆ SubscribeToJobUpdates()

Member Data Documentation

◆ apiClient

Property Documentation

◆ Administration

◆ Groups

◆ Instances

◆ Timeout

◆ Token

◆ Transfer

◆ Url

◆ Users