Destination | roletalk

Destination represents a role (a service) of remote peers (Units). Destination is used as a gateway for outgoing communication. It implements round-robin load balancing between units

This class should not be instantiated directly. It is exposed for type declaration and documentation

Hierarchy

EventEmitter
- Destination

Index

Events

Properties

Accessors

Events

on

on(event: "close", handler: () => void): Destination
on(event: "unit", handler: (unit: Unit) => void): Destination

- Defined in src/Destination.ts:220
Not tested yet. Event 'close' is dispatched when last unit gets disconnected

Parameters
- event: "close"
- handler: () => void
  - - (): void
    - Returns void
Returns Destination
- Defined in src/Destination.ts:224
Event 'unit' is dispatched when destination gets new unit connected

Parameters
- event: "unit"
- handler: (unit: Unit) => void
  - - (unit: Unit): void
    - Parameters
      - unit: Unit
      Returns void
Returns Destination

Properties

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

name

get name(): string

- Defined in src/Destination.ts:37
Name of the destination

Returns string

peer

get peer(): Peer

- Defined in src/Destination.ts:42
Get Peer instance

Returns Peer

ready

get ready(): boolean

- Defined in src/Destination.ts:208
Returns true if there is at least one Unit serving corresponding Role

Returns boolean

units

get units(): Unit[]

- Defined in src/Destination.ts:32
Array of connected Units

Returns Unit[]

Methods

Readable

Readable(event: string | EmitOptions, data: sendableData, options?: ReadableOptions): Readable

- Defined in src/Destination.ts:131
Send request to establish binary stream session. This end of the stream is readable (receives data only) If chosen Unit will reject the request, Writable will emit "error" event If there are not connected Units serving corresponding Role, method will throw synchronous error. To ensure at least one unit is connected, use Destination.ready

Parameters
- event: string | EmitOptions
- data: sendableData
- Optional options: ReadableOptions
Returns Readable

Writable

Writable(event: string | EmitOptions, data: sendableData, options?: WritableOptions): Writable

- Defined in src/Destination.ts:160
Send request to establish binary stream session. This end of the stream is writable (forwards data only) If chosen Unit will reject the request, Writable will emit "error" event If there are not connected Units serving corresponding Role, method will throw synchronous error. To ensure at least one unit is connected, use Destination.ready

Parameters
- event: string | EmitOptions
- data: sendableData
- Optional options: WritableOptions
Returns Writable

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

broadcast

broadcast(event: string | EmitOptions, data: sendableData): void

- Defined in src/Destination.ts:77
Send one-way message to all units serving the role

Parameters
- event: string | EmitOptions
- data: sendableData
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:64
Returns number

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

once

once(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:59
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Destination

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns Destination

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): Destination

- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Destination

request

request(event: string | EmitOptions, data: sendableData, cb?: (err: null | Error, ctx: Context) => void): Promise<Context>

- Defined in src/Destination.ts:87
Send request. If cb argument is not provided, returns Promise<Context> If there are not connected Units serving corresponding Role, method will throw synchronous error. To ensure at least one unit is connected, use Destination.ready

Parameters
- event: string | EmitOptions
- data: sendableData
- Optional cb: (err: null | Error, ctx: Context) => void
  - - (err: null | Error, ctx: Context): void
    - Parameters
      - err: null | Error
      - ctx: Context
      Returns void
Returns Promise<Context>

send

send(event: string | EmitOptions, data: sendableData, cb?: (err: Error) => void): undefined | Unit

- Defined in src/Destination.ts:47
Send one-way message. Use cb argument to ensure the message has benn written to underlying socket. Returns Unit chosen to send data to

Parameters
- event: string | EmitOptions
- data: sendableData
- Optional cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns undefined | Unit

setMaxListeners

setMaxListeners(n: number): Destination

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns Destination

survey

survey(event: string | EmitOptions, data: sendableData, cb: (err: null | Error, ctx: Context) => void): number

- Defined in src/Destination.ts:115
Send requests to each unit of the role. Callback cb will be applied to each request If there are not connected Units serving corresponding Role, method will throw synchronous error. To ensure at least one unit is connected, use Destination.ready

Parameters
- event: string | EmitOptions
- data: sendableData
- cb: (err: null | Error, ctx: Context) => void
  - - (err: null | Error, ctx: Context): void
    - Parameters
      - err: null | Error
      - ctx: Context
      Returns void
Returns number

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Index

Events

Properties

Accessors

Methods

Events

on

Parameters

event: "close"

handler: () => void

Returns void

Returns Destination

Parameters

event: "unit"

handler: (unit: Unit) => void

Parameters

unit: Unit

Returns void

Returns Destination

Properties

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Accessors

name

Returns string

peer

Returns Peer

ready

Returns boolean

units

Returns Unit[]

Methods

Readable

Parameters

event: string | EmitOptions

data: sendableData

Optional options: ReadableOptions

Returns Readable

Writable

Parameters

event: string | EmitOptions

data: sendableData

Optional options: WritableOptions

Returns Writable

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns Destination

broadcast

Parameters

event: string | EmitOptions

data: sendableData

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol