Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RICFileHandler

Hierarchy

  • RICFileHandler

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private BLOCK_ACK_TIMEOUT_MS

BLOCK_ACK_TIMEOUT_MS: number = 30000

Private MAX_OUTSTANDING_FILE_BLOCK_SEND_PROMISES

MAX_OUTSTANDING_FILE_BLOCK_SEND_PROMISES: number = 1

Private _ackedFilePos

_ackedFilePos: number = 0

Private _batchAckReceived

_batchAckReceived: boolean = false

Private _batchAckSize

_batchAckSize: number = 0

Private _commsStats

_commsStats: RICCommsStats

Private _fileBlockSize

_fileBlockSize: number = 0

Private _isCancelled

_isCancelled: boolean = false

Private _msgAwaitList

_msgAwaitList: FileBlockTrackInfo[] = ...

Private _msgHandler

_msgHandler: RICMsgHandler

Private _requestedBatchAckSize

_requestedBatchAckSize: number = 10

Private _requestedFileBlockSize

_requestedFileBlockSize: number = 500

Private _sendWithoutBatchAcks

_sendWithoutBatchAcks: boolean = false

Methods

_sendFileBlock

  • _sendFileBlock(fileContents: Uint8Array, blockStart: number): Promise<boolean>

  • Parameters

    • fileContents: Uint8Array
    • blockStart: number

    Returns Promise<boolean>

_sendFileCancelMsg

  • _sendFileCancelMsg(): Promise<void>

_sendFileContents

  • _sendFileContents(fileContents: Uint8Array, progressCallback: undefined | ((sent: number, total: number, progress: number) => void)): Promise<boolean>

  • Parameters

    • fileContents: Uint8Array
    • progressCallback: undefined | ((sent: number, total: number, progress: number) => void)

    Returns Promise<boolean>

_sendFileEndMsg

  • _sendFileEndMsg(fileName: string, fileType: RICFileSendType, fileContents: Uint8Array): Promise<boolean>

_sendFileStartMsg

  • _sendFileStartMsg(fileName: string, fileType: RICFileSendType, fileContents: Uint8Array): Promise<boolean>

awaitOutstandingMsgPromises

  • awaitOutstandingMsgPromises(all: boolean): Promise<void>

batchAck

  • batchAck(timeout: number): Promise<void>

fileSend

  • fileSend(fileName: string, fileType: RICFileSendType, fileContents: Uint8Array, progressCallback: undefined | ((sent: number, total: number, progress: number) => void)): Promise<boolean>

  • Parameters

    • fileName: string
    • fileType: RICFileSendType
    • fileContents: Uint8Array
    • progressCallback: undefined | ((sent: number, total: number, progress: number) => void)

    Returns Promise<boolean>

fileSendCancel

  • fileSendCancel(): Promise<void>

onOktoMsg

  • onOktoMsg(fileOkTo: number): void

setRequestedBatchAckSize

  • setRequestedBatchAckSize(batchAckSize: number): void

setRequestedFileBlockSize

  • setRequestedFileBlockSize(blockSize: number): void

Generated using TypeDoc