Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageBuilder

  subscribe now with sterfive to access the online-user manual

param
param

the security Mode

param

object that provides a constructObject(id) method

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly _packetAssembler

_packetAssembler: PacketAssembler

_tick0

_tick0: number

_tick1

_tick1: number

channelId

channelId: number

cryptoFactory

cryptoFactory: CryptoFactory

Readonly options

options: { signatureLength?: number }

Type declaration

  • Optional signatureLength?: number

Optional securityHeader

securityHeader: SecurityHeader

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

sequenceHeader

sequenceHeader: SequenceHeader

Readonly signatureLength

signatureLength: number

totalMessageSize

totalMessageSize: number

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.

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

dispose

  • dispose(): void

  • Returns void

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

feed

  • feed(data: Buffer): void

  • Feed message builder with some data

    method

    feed

    Parameters

    • data: Buffer

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

on

  • on(event: string | symbol, listener: (...args: any[]) => void): MessageBuilder

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

pushNewToken

  • pushNewToken(securityToken: SecurityToken, derivedKeys: DerivedKeys): void

  • Parameters

    Returns void

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MessageBuilder

setMaxListeners

setSecurity

  • Parameters

    Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

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

  • 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[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc