Documentation

ConcurrentTransfer extends AbstractTransfer

in package

• Application

A transfer type which executes in a concurrent fashion, i.e. with multiple workers uploading at once. Each worker is charged with uploading a particular chunk of data. The entity body is fragmented into n pieces - calculated by dividing the total size by the individual part size.

Tags

codeCoverageIgnore

Table of Contents

DEFAULT_PART_SIZE  = 1073741824

Default chunk size is 1GB.

MAX_PART_SIZE  = 5368709120

Maximum chunk size is 5GB.

MIN_PART_SIZE  = 1048576

Minimum chunk size is 1MB.

$client  : Client

$defaultOptions  : array<string|int, mixed>

$entityBody  : EntityBody

$options  : array<string|int, mixed>

$partSize  : int

$transferState  : TransferState

The current state of the transfer responsible for, among other things, holding an itinerary of uploaded parts

getOptions()  : array<string|int, mixed>

getPartSize()  : mixed

newInstance()  : static

setClient()  : $this

setEntityBody()  : $this

setOption()  : $this

setOptions()  : $this

setTransferState()  : $this

setup()  : $this

transfer()  : mixed

upload()  : Response

Initiates the upload procedure.

validatePartSize()  : mixed

Make sure the part size falls within a valid range

collectParts()  : array<string|int, mixed>

Partitions the entity body into an array - each worker is represented by a key, and the value is a ReadLimitEntityBody object, whose read limit is fixed based on this object's partSize value. This will always ensure the chunks are sent correctly.

createManifest()  : Response

With large uploads, you must create a manifest file. Although each segment or TransferPart remains individually addressable, the manifest file serves as the unified file (i.e. the 5GB download) which, when retrieved, streams all the segments concatenated.