Options
All
  • Public
  • Public/Protected
  • All
Menu

Monitor the active user limit (or any limit you desire), and block the bridge when it's exceeded.

Bridge blocking is represented by an isBlocked attribute, and it's up to the implementation to decide what to do with that information.

If a custom blocking/unblocking implementation is needed, override blockBridge() and unblockBridge() respectively. It's the caller's responsibility to call the base class methods to flip the actual isBlocked flag. Any errors thrown in the custom implementations get automatically caught (and logged) by checkLimits()

param

The upper user limit - the bridge gets blocked when it gets exceeded (not reached!)

Hierarchy

  • BridgeBlocker

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_isBlocked

_isBlocked: boolean = false

Accessors

isBlocked

  • get isBlocked(): boolean

Methods

blockBridge

  • blockBridge(): Promise<void>

checkLimits

  • checkLimits(users: number): Promise<void>

unblockBridge

  • unblockBridge(): Promise<void>

Generated using TypeDoc