Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Role

Role represents a service on the local Peer. It should handle incoming messages, requests and stream requests for certain functionality

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

Hierarchy

  • EventEmitter
    • Role

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Role(name: string, peer: Peer, active?: boolean): Role

Properties

Readonly name

name: string

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

active

  • get active(): boolean

  • get role status. Active means that role is enabled. If role is not active, all incoming data to the role will be rejected

    Returns boolean

peer

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

disable

  • disable(): void

  • Deactivate role. All units will be notified immediately with rebuilding their state

    Returns void

emit

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

  • Parameters

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

    Returns boolean

enable

  • enable(): void

  • Activate role. All units will be notified immediately with rebuilding their state

    Returns void

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

onData

onMessage

onReadable

  • onReadable(msg: string, handler: ReadableHandler): undefined | EventEmitter

  • Set handler for incoming request for receiving stream data

    Parameters

    Returns undefined | EventEmitter

onRequest

onWritable

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Role

  • Parameters

    • Optional event: string | symbol

    Returns Role

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Role

setMaxListeners

  • setMaxListeners(n: number): Role

  • Parameters

    • n: number

    Returns Role

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