@pumpkin-plugins/distant-horizons-support-pumpkin API / flow/transfer-cursor / TransferCursor
Class: TransferCursor ​
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:21
Emits one DH transfer packet at a time while retaining the source payload.
Accessors ​
done ​
Get Signature ​
get done():
boolean
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:71
Whether every data fragment and the final response have been sent.
Returns ​
boolean
hasInFlightBuffer ​
Get Signature ​
get hasInFlightBuffer():
boolean
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:76
Whether the client currently owns an in-progress assembly buffer for this transfer.
Returns ​
boolean
packetCount ​
Get Signature ​
get packetCount():
number
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:91
Estimated total packets after counting sent packets and current fragment sizing.
Returns ​
number
remainingPackets ​
Get Signature ​
get remainingPackets():
number
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:86
Number of data fragments and the final response still waiting to be sent.
Returns ​
number
retainedBytes ​
Get Signature ​
get retainedBytes():
number
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:81
Number of source payload bytes retained until completion or cancellation.
Returns ​
number
Methods ​
advance() ​
advance():
void
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:57
Advances after the current packet has been sent.
Returns ​
void
peek() ​
peek():
Uint8Array<ArrayBufferLike> |undefined
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:46
Returns the next packet without advancing the transfer.
Returns ​
Uint8Array<ArrayBufferLike> | undefined
setBandwidthRate() ​
setBandwidthRate(
bandwidthKbps):void
Defined in: packages/distant-horizons-support-pumpkin/src/flow/transfer-cursor.ts:38
Resizes only unsent fragments after the client changes its requested bandwidth.
Parameters ​
bandwidthKbps ​
number
Returns ​
void