Classdefault<S>

Wrapper for I/O stream using Request for out and Packet to in

Type Parameters

S extends Duplex

Hierarchy

TypedEmitter<ConnectionEvents>
- default

Index

Constructors

constructor

new default<S>(stream, open?, timeout?): default<S>
Constructor
Type Parameters
- S extends Duplex
Parameters
- stream: S
 wrapped I/O stream
- open: boolean = true
 automatically opens this connection, see Connection.open
- timeout: number = 1000
 default timeout for this connection
Returns default<S>
Overrides TypedEmitter<ConnectionEvents>.constructor
- Defined in packages/codec/src/Connection.ts:69

Properties

maxLength

maxLength: number = 256

Maximum default data length in single Request for this connection

`Protected`queue

queue: WaitingRequest[] = []

`Protected`ready

ready: Promise<void> = ...

`Readonly`stream

stream: S

wrapped I/O stream

timeout

timeout: number = 1000

Default timeout for this connection

`Static`defaultMaxListeners

defaultMaxListeners: number

Accessors

isConnected

get isConnected(): boolean
Returns true if the connection is ready for writing.

Returns boolean
- Defined in packages/codec/src/Connection.ts:78

Methods

addListener

addListener(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

close

close(): void
Detaches streams. Emits ConnectionEvents.close

Returns void
- Defined in packages/codec/src/Connection.ts:103

emit

emit(event, ...args): boolean
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- Rest...args: Parameters<ConnectionEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof ConnectionEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

`Protected`getMaxLength

getMaxLength(req): number
Parameters
- req: default<boolean>
Returns number
- Defined in packages/codec/src/Connection.ts:240

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:24

`Protected`listener

listener(res): void
Parameters
- res: Packet
Returns void
- Defined in packages/codec/src/Connection.ts:234

listenerCount

listenerCount(type): number
Parameters
- type: keyof ConnectionEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type): ConnectionEvents[U][]
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- type: U
Returns ConnectionEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

open

open(): void
Pipes streams (encoder->stream->decoder) together. Emits ConnectionEvents.open

Returns void
- Defined in packages/codec/src/Connection.ts:86

prependListener

prependListener(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(type): ConnectionEvents[U][]
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- type: U
Returns ConnectionEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: keyof ConnectionEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(event, listener): this
Type Parameters
- U extends keyof ConnectionEvents
Parameters
- event: U
- listener: ConnectionEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

send

send<Broadcast>(req): Response<Broadcast, false>
Decodes the request and sends the raw data to the stream after the previous operation completes, If the request length exceeds the maxLength, the request will be split into multiple requests and responses will be composed.
Type Parameters
- Broadcast extends boolean
Parameters
- req: default<Broadcast>
 request
Returns Response<Broadcast, false>
If the request is not broadcast, then a successful response to the request is returned. If the response status is not successful or a timeout occurs, an exception is thrown.
See
- TimeoutError
- ResponseError
- Defined in packages/codec/src/Connection.ts:127

`Protected`sendImpl

sendImpl<Broadcast, SkipErrors>(req, skipError?): Response<Broadcast, SkipErrors>
Type Parameters
- Broadcast extends boolean
- SkipErrors extends boolean = false
Parameters
- req: default<Broadcast>
- OptionalskipError: SkipErrors
Returns Response<Broadcast, SkipErrors>
- Defined in packages/codec/src/Connection.ts:170

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25

trySend

trySend(req): Promise<null | Packet>
Sends a request, length of which does not exceed maxLength.
Parameters
- req: default<false>
Returns Promise<null | Packet>
In case of no response by timeout, returns null. Don't forget to check the ack status of a response packet.
- Defined in packages/codec/src/Connection.ts:164

`Protected`wait

wait<SkipErrors>(req, skipErrors?): Promise<Result<SkipErrors>>
Type Parameters
- SkipErrors extends boolean = false
Parameters
- req: default<false>
- OptionalskipErrors: SkipErrors
Returns Promise<Result<SkipErrors>>
- Defined in packages/codec/src/Connection.ts:206

Classdefault<S>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns default<S>

Properties

maxLength

Protectedqueue

Protectedready

Readonlystream

timeout

StaticdefaultMaxListeners

Accessors

isConnected

Returns boolean

Methods

addListener

Type Parameters

Parameters

Returns this

close

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

ProtectedgetMaxLength

Parameters

Returns number

getMaxListeners

Returns number

Protectedlistener

Parameters

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ConnectionEvents[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

open

Returns void

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

Returns ConnectionEvents[U][]

removeAllListeners

Parameters

`Protected`queue

`Protected`ready

`Readonly`stream

`Static`defaultMaxListeners

`Protected`getMaxLength

`Protected`listener

`Protected`sendImpl

`Protected`wait