Tgstation.Server.Client.ITransferClient Interface Reference

For transferring data Streams. More...

Inheritance diagram for Tgstation.Server.Client.ITransferClient:

Public Member Functions
ValueTask< Stream >	Download (FileTicketResponse ticket, CancellationToken cancellationToken)
	Downloads a file Stream for a given ticket .
ValueTask	Upload (FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)
	Uploads a given uploadStream for a given ticket .

Detailed Description

For transferring data Streams.

Definition at line 12 of file ITransferClient.cs.

Member Function Documentation

Download()

ValueTask< Stream > Tgstation.Server.Client.ITransferClient.Download	(	FileTicketResponse	ticket,
		CancellationToken	cancellationToken
	)

Downloads a file Stream for a given ticket .

Parameters

ticket	The FileTicketResponse to download.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the downloaded Stream.

Implemented in Tgstation.Server.Client.ApiClient.

Upload()

ValueTask Tgstation.Server.Client.ITransferClient.Upload	(	FileTicketResponse	ticket,
		Stream?	uploadStream,
		CancellationToken	cancellationToken
	)

Uploads a given uploadStream for a given ticket .

Parameters

ticket	The FileTicketResponse to download.
uploadStream	The Stream to upload. null represents an empty file.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

---

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

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