Properties
Readonly MIDDLEWARE_HANDSHAKE
MIDDLEWARE_HANDSHAKE: "handshake"
Readonly MIDDLEWARE_INBOUND
MIDDLEWARE_INBOUND: "inbound"
Readonly MIDDLEWARE_INBOUND_RAW
MIDDLEWARE_INBOUND_RAW: "inboundRaw"
Readonly MIDDLEWARE_OUTBOUND
MIDDLEWARE_OUTBOUND: "outbound"
Readonly SYMBOL_MIDDLEWARE_HANDSHAKE_STREAM
SYMBOL_MIDDLEWARE_HANDSHAKE_STREAM: symbol
ackTimeout
ackTimeout: number
allowClientPublish
allowClientPublish: boolean
auth
brokerEngine
brokerEngine: AGSimpleBroker
clients
clients: {
[id: string]: AGServerSocket;
}
Type declaration
-
[id: string]: AGServerSocket
clientsCount
clientsCount: number
codec
defaultSignatureOptions
defaultSignatureOptions: {
algorithm?: string;
expiresIn: number;
}
Type declaration
-
Optional algorithm?: string
-
expiresIn: number
defaultVerificationOptions
defaultVerificationOptions: {
algorithms?: string[];
}
Type declaration
-
Optional algorithms?: string[]
exchange
exchange: SimpleExchange
handshakeTimeout
handshakeTimeout: number
httpServer
httpServer: Server<typeof IncomingMessage, typeof ServerResponse>
isReady
isReady: boolean
middlewareEmitFailures
middlewareEmitFailures: boolean
options
origins
origins: string
pendingClients
pendingClients: {
[id: string]: AGServerSocket;
}
Type declaration
-
[id: string]: AGServerSocket
pendingClientsCount
pendingClientsCount: number
Optional perMessageDeflate
perMessageDeflate?: boolean | {}
pingInterval
pingInterval: number
pingTimeout
pingTimeout: number
pingTimeoutDisabled
pingTimeoutDisabled: boolean
protocolVersion
protocolVersion: 2 | 1
Optional signatureKey
signatureKey?: Secret
Optional socketChannelLimit
socketChannelLimit?: number
strictHandshake
strictHandshake: boolean
Optional verificationKey
verificationKey?: Secret
verifyHandshake
verifyHandshake: VerifyClientCallbackAsync
wsServer
wsServer: Server<WebSocket>