Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerSidePublishEngine

a Publish Engine for a given session

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

isSessionClosed

isSessionClosed: boolean = false

maxPublishRequestInQueue

maxPublishRequestInQueue: number = 0

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

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.

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Accessors

currentMonitoredItemCount

  • get currentMonitoredItemCount(): number

  • Returns number

hasLateSubscriptions

  • get hasLateSubscriptions(): boolean

  • Returns boolean

pendingClosedSubscriptionCount

  • get pendingClosedSubscriptionCount(): number

  • Returns number

pendingPublishRequestCount

  • get pendingPublishRequestCount(): number

  • number of pending PublishRequest available in queue

    Returns number

subscriptionCount

  • get subscriptionCount(): number

  • number of subscriptions

    Returns number

subscriptions

  • get a array of subscription handled by the publish engine.

    Returns Subscription[]

Methods

_on_tick

  • _on_tick(): void

_purge_dangling_subscription

  • _purge_dangling_subscription(subscriptionId: number): void

  • Parameters

    • subscriptionId: number

    Returns void

_send_response

  • _send_response(subscription: Subscription, response: PublishResponse): void

_send_response_for_request

  • _send_response_for_request(publishData: PublishData, response: PublishResponse): void

  • Parameters

    Returns void

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

add_subscription

  • Parameters

    Returns Subscription

cancelPendingPublishRequestBeforeChannelChange

  • cancelPendingPublishRequestBeforeChannelChange(): void

  • Returns void

detach_subscription

  • Parameters

    Returns Subscription

dispose

  • dispose(): void

  • Returns void

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

findLateSubscriptions

  • Returns Subscription[]

findLateSubscriptionsSortedByAge

  • Returns Subscription[]

getMaxListeners

  • getMaxListeners(): number

getSubscriptionById

  • getSubscriptionById(subscriptionId: number | string): Subscription

  • retrieve a subscription by id.

    Parameters

    • subscriptionId: number | string

    Returns Subscription

    Subscription

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: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

onSessionClose

  • onSessionClose(): void

  • Returns void

on_close_subscription

once

  • once(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

process_subscriptionAcknowledgements

  • process_subscriptionAcknowledgements(subscriptionAcknowledgements: SubscriptionAcknowledgement[]): StatusCode[]

  • Parameters

    • subscriptionAcknowledgements: SubscriptionAcknowledgement[]

    Returns StatusCode[]

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send_keep_alive_response

  • send_keep_alive_response(subscriptionId: number, future_sequence_number: number): boolean

  • call by a subscription when no notification message is available after the keep alive delay has expired.

    method

    send_keep_alive_response

    Parameters

    • subscriptionId: number
    • future_sequence_number: number

    Returns boolean

    true if a publish response has been sent

setMaxListeners

  • setMaxListeners(n: number): this

shutdown

  • shutdown(): void

  • Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc