Class SocketReader

Reader that merges input buffers an delivers parts splitted by a token or a fixed length.

Index

Constructors

Properties

timeout dataWaitResolve dataWaitReject decoder

Methods

receiveData getSocket readRemainingInputBuffer setTimeoutRead waitForData readByLength readUntilEnd readByToken readByTokenOrLength readStringByToken readStringLine readStringByLength hasData

Constructors

constructor

new SocketReader(socket: TlsWebSocket): SocketReader
Parameters
- socket: TlsWebSocket
  Socket that is used for the transport, overrides the "onmessage" callback.
Returns SocketReader

Properties

timeout

timeout: number

dataWaitResolve

dataWaitResolve: undefined | ((value: void | PromiseLike<void>) => void)

dataWaitReject

dataWaitReject: undefined | ((reason?: unknown) => void)

decoder

decoder: TextDecoder

Methods

`Protected`receiveData

receiveData(data: ArrayBuffer | Uint8Array): void
Parameters
- data: ArrayBuffer | Uint8Array
Returns void

getSocket

getSocket(): TlsWebSocket
Returns TlsWebSocket

readRemainingInputBuffer

readRemainingInputBuffer(): Uint8Array
Returns the complete input buffer stored within this reader

Returns Uint8Array

setTimeoutRead

setTimeoutRead(timeout: number): void
Sets the read timeout in ms
Parameters
- timeout: number
  timeout in ms
Returns void

waitForData

waitForData(timeout: number): Promise<void>
Parameters
- timeout: number
Returns Promise<void>

readByLength

readByLength(totalLength: number): Promise<Uint8Array>
Parameters
- totalLength: number
Returns Promise<Uint8Array>

readUntilEnd

readUntilEnd(): Promise<Uint8Array>
Reads the Complete Rest of the Socket until it is closed.

Returns Promise<Uint8Array>
Uint8Array with the remaining data. Can be Empty.

readByToken

readByToken(token: number[], excludeToken?: boolean): Promise<Uint8Array>
Reads Data until next of the given token.
Parameters
- token: number[]
  A byte series used as delimiter token.
- OptionalexcludeToken: boolean
  When set to true the token will not be within the result. Default ist true
Returns Promise<Uint8Array>
Uint8Array with the data starting from the current position until the token.

readByTokenOrLength

readByTokenOrLength(
    token: number[],
    maxLength: number,
    excludeToken?: boolean,
): Promise<BufferedSearchResult>
Reads Data until next of the given token.
Parameters
- token: number[]
  A byte series used as delimiter token.
- maxLength: number
- OptionalexcludeToken: boolean
  When set to true the token will not be within the result. Default ist true
Returns Promise<BufferedSearchResult>
Uint8Array with the data starting from the current position until the token.

readStringByToken

readStringByToken(token: number[]): Promise<string>
Reads Data until next of the given token.
Parameters
- token: number[]
  A byte series used as delimiter token.
Returns Promise<string>
String with the data starting from the current position until the token ( the token will not be included.)

readStringLine

readStringLine(): Promise<string>
Reads Data until line end and returns as string.

Returns Promise<string>
String with the data starting from the current position until the end of the line ( \r\n ).

readStringByLength

readStringByLength(length: number): Promise<string>
Parameters
- length: number
Returns Promise<string>

hasData

hasData(): boolean
Returns boolean