Tgstation.Server.Client.AdministrationClient Class Reference

More...

Inheritance diagram for Tgstation.Server.Client.AdministrationClient:

Collaboration diagram for Tgstation.Server.Client.AdministrationClient:

Public Member Functions
	AdministrationClient (IApiClient apiClient)
	Initializes a new instance of the AdministrationClient class.
ValueTask< AdministrationResponse >	Read (bool forceFresh, CancellationToken cancellationToken)
	Get the AdministrationResponse represented by the IAdministrationClient. Parameters forceFresh If true the response will be forcefully regenerated. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the AdministrationResponse represented by the IAdministrationClient.
async ValueTask< ServerUpdateResponse >	Update (ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken)
	Updates the AdministrationResponse setttings. Parameters updateRequest The ServerUpdateRequest. zipFileStream The Stream for the .zip file if ServerUpdateRequest.UploadZip is true. Will be ignored if it is false. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the echoed ServerUpdateResponse.
ValueTask	Restart (CancellationToken cancellationToken)
	Restarts the TGS server. Parameters cancellationToken The CancellationToken for the operation. Returns A ValueTask representing the running operation.
ValueTask< List< LogFileResponse > >	ListLogs (PaginationSettings? paginationSettings, CancellationToken cancellationToken)
	Lists the log files available for download. Parameters paginationSettings The optional PaginationSettings for the operation. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in an List<T> of LogFileResponse metadata.
async ValueTask< Tuple< LogFileResponse, Stream > >	GetLog (LogFileResponse logFile, CancellationToken cancellationToken)
	Download a given logFile . Parameters logFile The LogFileResponse to download. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting a Tuple<T1, T2> containing the downloaded LogFileResponse and associated Stream.
Public Member Functions inherited from Tgstation.Server.Client.PaginatedClient
	PaginatedClient (IApiClient apiClient)
	Initializes a new instance of the PaginatedClient class.

Additional Inherited Members
Protected Member Functions inherited from Tgstation.Server.Client.PaginatedClient
async ValueTask< List< TModel > >	ReadPaged< TModel > (PaginationSettings? paginationSettings, string route, long? instanceId, CancellationToken cancellationToken)
	Reads a given route with paged results.
Properties inherited from Tgstation.Server.Client.PaginatedClient
IApiClient	ApiClient [get]
	The IApiClient for the PaginatedClient.

Detailed Description

Definition at line 15 of file AdministrationClient.cs.

Constructor & Destructor Documentation

AdministrationClient()

Tgstation.Server.Client.AdministrationClient.AdministrationClient

(

IApiClient

apiClient

)

Initializes a new instance of the AdministrationClient class.

Parameters

apiClient

The IApiClient for the PaginatedClient.

Definition at line 21 of file AdministrationClient.cs.

            : base(apiClient)
        {
        }

Member Function Documentation

GetLog()

async ValueTask< Tuple< LogFileResponse, Stream > > Tgstation.Server.Client.AdministrationClient.GetLog	(	LogFileResponse	logFile,
		CancellationToken	cancellationToken
	)

Download a given logFile .

Parameters

logFile	The LogFileResponse to download.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting a Tuple<T1, T2> containing the downloaded LogFileResponse and associated Stream.

Implements Tgstation.Server.Client.IAdministrationClient.

Definition at line 60 of file AdministrationClient.cs.

        {
            var resultFile = await ApiClient.Read<LogFileResponse>(
                Routes.Logs + Routes.SanitizeGetPath(
                    HttpUtility.UrlEncode(
                        logFile?.Name ?? throw new ArgumentNullException(nameof(logFile)))),
                cancellationToken)
                .ConfigureAwait(false);
 
            var stream = await ApiClient.Download(resultFile, cancellationToken).ConfigureAwait(false);
            try
            {
                return Tuple.Create(resultFile, stream);
            }
            catch
            {
                stream.Dispose();
                throw;
            }
        }

References Tgstation.Server.Client.ApiClient.Download(), Tgstation.Server.Api.Models.Response.LogFileResponse.Name, and Tgstation.Server.Api.Routes.SanitizeGetPath().

Here is the call graph for this function:

ListLogs()

ValueTask< List< LogFileResponse > > Tgstation.Server.Client.AdministrationClient.ListLogs	(	PaginationSettings?	paginationSettings,
		CancellationToken	cancellationToken
	)

Lists the log files available for download.

Parameters

paginationSettings	The optional PaginationSettings for the operation.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in an List<T> of LogFileResponse metadata.

Implements Tgstation.Server.Client.IAdministrationClient.

Read()

ValueTask< AdministrationResponse > Tgstation.Server.Client.AdministrationClient.Read	(	bool	forceFresh,
		CancellationToken	cancellationToken
	)

Get the AdministrationResponse represented by the IAdministrationClient.

Parameters

forceFresh	If true the response will be forcefully regenerated.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the AdministrationResponse represented by the IAdministrationClient.

Implements Tgstation.Server.Client.IAdministrationClient.

Restart()

ValueTask Tgstation.Server.Client.AdministrationClient.Restart

(

CancellationToken

cancellationToken

)

Restarts the TGS server.

Parameters

cancellationToken

The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implements Tgstation.Server.Client.IAdministrationClient.

Update()

async ValueTask< ServerUpdateResponse > Tgstation.Server.Client.AdministrationClient.Update	(	ServerUpdateRequest	updateRequest,
		Stream?	zipFileStream,
		CancellationToken	cancellationToken
	)

Updates the AdministrationResponse setttings.

Parameters

updateRequest	The ServerUpdateRequest.
zipFileStream	The Stream for the .zip file if ServerUpdateRequest.UploadZip is true. Will be ignored if it is false.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the echoed ServerUpdateResponse.

Implements Tgstation.Server.Client.IAdministrationClient.

Definition at line 30 of file AdministrationClient.cs.

        {
            if (updateRequest == null)
                throw new ArgumentNullException(nameof(updateRequest));
 
            if (updateRequest.UploadZip == true && zipFileStream == null)
                throw new ArgumentNullException(nameof(zipFileStream));
 
            var result = await ApiClient.Update<ServerUpdateRequest, ServerUpdateResponse>(
                Routes.Administration,
                updateRequest,
                cancellationToken);
 
            if (updateRequest.UploadZip == true)
                await ApiClient.Upload(result, zipFileStream, cancellationToken).ConfigureAwait(false);
 
            return result;
        }

References Tgstation.Server.Api.Routes.Administration, Tgstation.Server.Client.ApiClient.Upload(), and Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip.

Here is the call graph for this function:

---

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

• src/Tgstation.Server.Client/AdministrationClient.cs