Hierarchy

  • AsyncStreamEmitter<any>
    • AGServer

Constructors

  • Parameters

    Returns AGServer

Properties

MIDDLEWARE_HANDSHAKE: "handshake"
MIDDLEWARE_INBOUND: "inbound"
MIDDLEWARE_INBOUND_RAW: "inboundRaw"
MIDDLEWARE_OUTBOUND: "outbound"
SYMBOL_MIDDLEWARE_HANDSHAKE_STREAM: symbol
ackTimeout: number
allowClientPublish: boolean
brokerEngine: AGSimpleBroker
clients: {
    [id: string]: AGServerSocket;
}

Type declaration

  • [id: string]: AGServerSocket
clientsCount: number
defaultSignatureOptions: {
    algorithm?: string;
    expiresIn: number;
}

Type declaration

  • Optional algorithm?: string
  • expiresIn: number
defaultVerificationOptions: {
    algorithms?: string[];
}

Type declaration

  • Optional algorithms?: string[]
exchange: SimpleExchange
handshakeTimeout: number
httpServer: Server<typeof IncomingMessage, typeof ServerResponse>
isReady: boolean
middlewareEmitFailures: boolean
origins: string
pendingClients: {
    [id: string]: AGServerSocket;
}

Type declaration

  • [id: string]: AGServerSocket
pendingClientsCount: number
perMessageDeflate?: boolean | {}
pingInterval: number
pingTimeout: number
pingTimeoutDisabled: boolean
protocolVersion: 2 | 1
signatureKey?: Secret
socketChannelLimit?: number
strictHandshake: boolean
verificationKey?: Secret
verifyHandshake: VerifyClientCallbackAsync
wsServer: Server<WebSocket>

Methods

  • Returns Promise<void>

  • Returns void

  • Parameters

    • eventName: string

    Returns void

  • Parameters

    • eventName: "error"
    • data: {
          error: Error;
      }
      • error: Error

    Returns void

  • Parameters

    • eventName: "warning"
    • data: {
          warning: Error;
      }
      • warning: Error

    Returns void

  • Parameters

    • eventName: "handshake"
    • data: {
          socket: AGServerSocket;
      }
      • socket: AGServerSocket

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • error: Error

    Returns void

  • Parameters

    • warning: Error

    Returns void

  • Returns string

  • Returns number

  • Returns ConsumerStats[]

  • Parameters

    • eventName: string

    Returns number

  • Parameters

    • consumerId: number

    Returns number

  • Parameters

    • consumerId: number

    Returns ConsumerStats

  • Parameters

    • eventName: string

    Returns ConsumerStats[]

  • Returns string

  • Parameters

    • consumerId: number

    Returns boolean

  • Parameters

    • eventName: string
    • consumerId: number

    Returns boolean

  • Parameters

    Returns boolean

  • Returns void

  • Parameters

    • eventName: string

    Returns void

  • Parameters

    • consumerId: number

    Returns void

  • Parameters

    • eventName: "error"

    Returns ConsumableStream<{
        error: Error;
    }>

  • Parameters

    • eventName: "warning"

    Returns ConsumableStream<{
        warning: Error;
    }>

  • Parameters

    • eventName: "handshake"

    Returns ConsumableStream<{
        socket: AGServerSocket;
    }>

  • Parameters

    • eventName: "authenticationStateChange"

    Returns ConsumableStream<AGServer.AuthStateChangeData>

  • Parameters

    • eventName: "authentication"

    Returns ConsumableStream<AuthenticationData>

  • Parameters

    • eventName: "deauthentication"

    Returns ConsumableStream<DeauthenticationData>

  • Parameters

    • eventName: "badSocketAuthToken"

    Returns ConsumableStream<BadSocketAuthTokenData>

  • Parameters

    • eventName: "connection"

    Returns ConsumableStream<ConnectionData>

  • Parameters

    • eventName: "subscription"

    Returns ConsumableStream<SubscriptionData>

  • Parameters

    • eventName: "unsubscription"

    Returns ConsumableStream<UnsubscriptionData>

  • Parameters

    • eventName: "connectionAbort"

    Returns ConsumableStream<ConnectionAbortData>

  • Parameters

    • eventName: "disconnection"

    Returns ConsumableStream<DisconnectionData>

  • Parameters

    • eventName: "closure"

    Returns ConsumableStream<ClosureData>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

Generated using TypeDoc