Class SBEvents

BSB Events Controller

This class is responsible for managing the events in the BSB framework. If you have a specific way of managing events, you can extend this class and then use your own class when creating the ServiceBase instance.

Index

Constructors

constructor

Methods

dispose init run addPlugin onBroadcast emitBroadcast onEvent onEventSpecific emitEvent emitEventSpecific onReturnableEvent onReturnableEventSpecific emitEventAndReturn emitEventAndReturnSpecific receiveStream sendStream

Constructors

constructor

new SBEvents(
    appId: string,
    mode: DEBUG_MODE,
    cwd: string,
    sbPlugins: SBPlugins,
    sbObservable: SBObservable,
    createObservable: (
        trace: DTrace,
        pluginName: string,
        attributes?: Record<string, string | number | boolean>,
    ) => Observable,
): SBEvents
Parameters
- appId: string
- mode: DEBUG_MODE
- cwd: string
- sbPlugins: SBPlugins
- sbObservable: SBObservable
- createObservable: (
      trace: DTrace,
      pluginName: string,
      attributes?: Record<string, string | number | boolean>,
  ) => Observable
Returns SBEvents
- Defined in src/serviceBase/events.ts:89

Methods

dispose

dispose(): void
Returns void
- Defined in src/serviceBase/events.ts:106

init

init(sbConfig: SBConfig, sbObservable: SBObservable): Promise<void>
Parameters
- sbConfig: SBConfig
- sbObservable: SBObservable
Returns Promise<void>
- Defined in src/serviceBase/events.ts:209

run

run(): Promise<void>
Returns Promise<void>
- Defined in src/serviceBase/events.ts:253

addPlugin

addPlugin(
    sbObservable: SBObservable,
    plugin: IPluginDefinition,
    reference: LoadedPlugin<"events">,
    config: any,
    filter?: EventsFilter,
): Promise<BSBEventsRef>
Parameters
- sbObservable: SBObservable
- plugin: IPluginDefinition
- reference: LoadedPlugin<"events">
- config: any
- Optionalfilter: EventsFilter
Returns Promise<BSBEventsRef>
- Defined in src/serviceBase/events.ts:276

onBroadcast

onBroadcast(
    context: BSBServiceClient<any> | BSBService<any, any>,
    trace: DTrace,
    pluginName: string,
    event: string,
    listener: (trace: DTrace, ...args: any[]) => void | Promise<void>,
): Promise<void>
Parameters
- context: BSBServiceClient<any> | BSBService<any, any>
- trace: DTrace
- pluginName: string
- event: string
- listener: (trace: DTrace, ...args: any[]) => void | Promise<void>
Returns Promise<void>
- Defined in src/serviceBase/events.ts:448

emitBroadcast

emitBroadcast(
    trace: DTrace,
    pluginName: string,
    event: string,
    ...args: any[],
): Promise<void>
Parameters
- trace: DTrace
- pluginName: string
- event: string
- ...args: any[]
Returns Promise<void>
- Defined in src/serviceBase/events.ts:476

onEvent

onEvent(
    trace: DTrace,
    context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>,
    pluginName: string,
    event: string,
    listener: (trace: DTrace, ...args: any[]) => void | Promise<void>,
): Promise<void>
Parameters
- trace: DTrace
- context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>
- pluginName: string
- event: string
- listener: (trace: DTrace, ...args: any[]) => void | Promise<void>
Returns Promise<void>
- Defined in src/serviceBase/events.ts:547

onEventSpecific

onEventSpecific(
    trace: DTrace,
    serverId: string,
    context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>,
    pluginName: string,
    event: string,
    listener: (trace: DTrace, ...args: any[]) => void | Promise<void>,
): Promise<void>
Parameters
- trace: DTrace
- serverId: string
- context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>
- pluginName: string
- event: string
- listener: (trace: DTrace, ...args: any[]) => void | Promise<void>
Returns Promise<void>
- Defined in src/serviceBase/events.ts:575

emitEvent

emitEvent(
    trace: DTrace,
    pluginName: string,
    event: string,
    ...args: any[],
): Promise<void>
Parameters
- trace: DTrace
- pluginName: string
- event: string
- ...args: any[]
Returns Promise<void>
- Defined in src/serviceBase/events.ts:604

emitEventSpecific

emitEventSpecific(
    trace: DTrace,
    serverId: string,
    pluginName: string,
    event: string,
    ...args: any[],
): Promise<void>
Parameters
- trace: DTrace
- serverId: string
- pluginName: string
- event: string
- ...args: any[]
Returns Promise<void>
- Defined in src/serviceBase/events.ts:630

onReturnableEvent

onReturnableEvent(
    trace: DTrace,
    context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>,
    pluginName: string,
    event: string,
    listener: (trace: DTrace, ...args: any[]) => any,
): Promise<void>
Parameters
- trace: DTrace
- context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>
- pluginName: string
- event: string
- listener: (trace: DTrace, ...args: any[]) => any
Returns Promise<void>
- Defined in src/serviceBase/events.ts:699

onReturnableEventSpecific

onReturnableEventSpecific(
    trace: DTrace,
    serverId: string,
    context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>,
    pluginName: string,
    event: string,
    listener: (trace: DTrace, ...args: any[]) => any,
): Promise<void>
Parameters
- trace: DTrace
- serverId: string
- context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>
- pluginName: string
- event: string
- listener: (trace: DTrace, ...args: any[]) => any
Returns Promise<void>
- Defined in src/serviceBase/events.ts:731

emitEventAndReturn

emitEventAndReturn(
    trace: DTrace,
    pluginName: string,
    event: string,
    timeoutSeconds: number,
    ...args: any[],
): Promise<any>
Parameters
- trace: DTrace
- pluginName: string
- event: string
- timeoutSeconds: number
- ...args: any[]
Returns Promise<any>
- Defined in src/serviceBase/events.ts:764

emitEventAndReturnSpecific

emitEventAndReturnSpecific(
    trace: DTrace,
    serverId: string,
    pluginName: string,
    event: string,
    timeoutSeconds: number,
    ...args: any[],
): Promise<any>
Parameters
- trace: DTrace
- serverId: string
- pluginName: string
- event: string
- timeoutSeconds: number
- ...args: any[]
Returns Promise<any>
- Defined in src/serviceBase/events.ts:817

receiveStream

receiveStream(
    trace: DTrace,
    context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>,
    pluginName: string,
    event: string,
    listener: (error: Error | null, stream: Readable) => Promise<void>,
    timeoutSeconds?: number,
): Promise<string>
Parameters
- trace: DTrace
- context: BSBService<any, BSBEventSchemas> | BSBServiceClient<any>
- pluginName: string
- event: string
- listener: (error: Error | null, stream: Readable) => Promise<void>
- OptionaltimeoutSeconds: number
Returns Promise<string>
- Defined in src/serviceBase/events.ts:919

sendStream

sendStream(
    trace: DTrace,
    pluginName: string,
    event: string,
    streamId: string,
    stream: Readable,
): Promise<void>
Parameters
- trace: DTrace
- pluginName: string
- event: string
- streamId: string
- stream: Readable
Returns Promise<void>
- Defined in src/serviceBase/events.ts:954

Class SBEvents

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SBEvents

Methods

dispose

Returns void

init

Parameters

Returns Promise<void>

run

Returns Promise<void>

addPlugin

Parameters

Returns Promise<BSBEventsRef>

onBroadcast

Parameters

Returns Promise<void>

emitBroadcast

Parameters

Returns Promise<void>

onEvent

Parameters

Returns Promise<void>

onEventSpecific

Parameters

Returns Promise<void>

emitEvent

Parameters

Returns Promise<void>

emitEventSpecific

Parameters

Returns Promise<void>

onReturnableEvent

Parameters

Returns Promise<void>

onReturnableEventSpecific

Parameters

Returns Promise<void>

emitEventAndReturn

Parameters

Returns Promise<any>

emitEventAndReturnSpecific

Parameters

Returns Promise<any>

receiveStream

Parameters

Returns Promise<string>

sendStream

Parameters

Returns Promise<void>

Settings

On This Page