IConcertFileSharingService

Implements a file sharing service used as a side channel to ConcertTransport to exchange large files.

Windows
MacOS
Linux

Inheritance Hierarchy

IConcertFileSharingService

FConcertLocalFileSharingService

References

Module

ConcertSyncCore

Header

/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/IConcertFileSharingService.h

Include

#include "IConcertFileSharingService.h"

Syntax

class IConcertFileSharingService

Remarks

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.

@note The lifetime of the shared files is implementation specific.

Destructors

Functions

Name Description

Public function

TSharedPtr< ...

 

CreateReader

(
    const FString& InFileId
)

Open a shared file for consumption.

Public function

bool

 

Publish

(
    const FString& Pathname,
    FString& OutFileId
)

Copy the specified files in a uniquely named file stored in the service directory for sharing.

Public function

bool

 

Publish

(
    FArchive& SrcAr,
    FString& OutFileId
)

Copies all the bytes contained in the archives in a uniquely named file stored in the service directory for sharing.

Public function

bool

 

Publish

(
    FArchive& SrcAr,
    int64 Count,
    FString& OutFileId
)

Copies up to Count bytes contained in the archives in a uniquely named file stored in the service directory for sharing.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss