Class Communication<P, C>

Type Parameters

Hierarchy

  • Communication

constructor

Primary Controls

errorCatcher inbound method outbound

General Properties

adapterOptions handlerName name target timeout? transferOptions

constructor

  • Type Parameters

    Parameters

    • name: string

      Identifier of communication

      Category

      General Properties

    • handlerName: string

      The TocketClientBase or TocketServer instance the communication is registered to.

      Category

      General Properties

    • Optional timeout: number

      How long to wait for answers from other endpoints.

      Category

      General Properties

    Returns Communication<P, C>

Primary Controls

errorCatcher

errorCatcher: ErrorCatcher = ...

Custom error handling function when main function fails

inbound

inbound: MessageTransformer = ...

Sets transformation function applied to incoming messages

method

method: HandlerMethod<P, C> = ...

Main logic for the socket communication. Potentially async.

outbound

outbound: MessageTransformer = ...

transformation function applied to outgoing messages.

General Properties

adapterOptions

adapterOptions: Record<string, any> = {}

Readonly handlerName

handlerName: string

The TocketClientBase or TocketServer instance the communication is registered to.

Readonly name

name: string

Identifier of communication

target

target: undefined | ConnectionFilter<C>

On Clients, default socket of communication

Optional timeout

timeout?: number

How long to wait for answers from other endpoints.

transferOptions

transferOptions: OptionsList = ...

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc