Navigation
API > API/Plugins > API/Plugins/Concert
Implements a file sharing service used as a side channel to ConcertTransport to exchange large files. This API is designed to work hand in hand with the request/response/event layer.
When a file needs to be exchanged between the client and the server:
The publisher side would:
- Publish a file using file sharing service. The service tracks the request and capture the file for sharing (can sent it to a server asynchronously, can be copied to a shared folder, etc.)
- Notify the consumer(s) by sending a Concert request/event/response with the ID of the published file.
The consumer(s) side would:
- Receive and process the Concert request/event/response and extract the file ID.
- Create a stream to read the shared file, ideally in a background task. If required, new method could be added to simplify asynchrous IO.
The lifetime of the shared files is implementation specific.
| Name | IConcertFileSharingService |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertFileSharingService.h |
| Include Path | #include "IConcertFileSharingService.h" |
Syntax
class IConcertFileSharingService
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertFileSharingService() |
IConcertFileSharingService.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Make a clone of this sharing service to be used. | IConcertFileSharingService.h | ||
TSharedPtr< FArchive > CreateReader
(
const FString& InFileId |
Open a shared file for consumption. | IConcertFileSharingService.h | |
TSharedPtr< FArchive > CreateWriter
(
FString& OutFileId |
Open a file for writing. | IConcertFileSharingService.h | |
void Delete
(
const FString& InFileId |
Deletes the specified outfile id. | IConcertFileSharingService.h | |
FString GetPath() |
Get the assign path for file sharing root. | IConcertFileSharingService.h | |
bool IsEnabled() |
Indicates if the file sharing service is enabled. | IConcertFileSharingService.h | |
| Copy the specified files in a uniquely named file stored in the service directory for sharing. | IConcertFileSharingService.h | ||
| Copies all the bytes contained in the archives in a uniquely named file stored in the service directory for sharing. | IConcertFileSharingService.h | ||
| Copies up to Count bytes contained in the archives in a uniquely named file stored in the service directory for sharing. | IConcertFileSharingService.h | ||
void SetEnabled
(
bool bInEnabled |
Turn on/off the file sharing service. | IConcertFileSharingService.h | |
| Sets the desired path to use for the service. | IConcertFileSharingService.h |