Class AGClientSocket

Hierarchy

  • AsyncStreamEmitter<any>
    • AGClientSocket

Implements

  • Client

Constructors

Properties

Methods

authenticate cancelBatch cancelBatching channel channelCloseAllListeners channelCloseListener channelCloseOutput channelGetAllListenersBackpressure channelGetAllListenersConsumerStatsList channelGetListenerBackpressure channelGetListenerConsumerStatsList channelGetOutputBackpressure channelGetOutputConsumerStatsList channelHasAnyListenerConsumer channelHasListenerConsumer channelHasOutputConsumer channelKillAllListeners channelKillListener channelKillOutput closeAllChannelListeners closeAllChannelOutputs closeAllChannels closeAllListeners closeAllProcedures closeAllReceivers closeChannel closeListener closeProcedure closeReceiver connect deauthenticate decode decodeBase64 disconnect emit encode encodeBase64 flushBatch getAllChannelListenersBackpressure getAllChannelListenersConsumerStatsList getAllChannelOutputsBackpressure getAllChannelOutputsConsumerStatsList getAllChannelsBackpressure getAllListenersBackpressure getAllListenersConsumerStatsList getAllProceduresBackpressure getAllProceduresConsumerStatsList getAllReceiversBackpressure getAllReceiversConsumerStatsList getAuthToken getBackpressure getBytesReceived getChannelBackpressure getChannelListenerConsumerBackpressure getChannelListenerConsumerStats getChannelOptions getChannelOutputConsumerBackpressure getChannelOutputConsumerStats getChannelState getListenerBackpressure getListenerConsumerBackpressure getListenerConsumerStats getListenerConsumerStatsList getProcedureBackpressure getProcedureConsumerBackpressure getProcedureConsumerStats getProcedureConsumerStatsList getReceiverBackpressure getReceiverConsumerBackpressure getReceiverConsumerStats getReceiverConsumerStatsList getSignedAuthToken getState hasAnyChannelListenerConsumer hasAnyChannelOutputConsumer hasAnyListenerConsumer hasAnyProcedureConsumer hasAnyReceiverConsumer hasListenerConsumer hasProcedureConsumer hasReceiverConsumer invoke invokePublish isSubscribed killAllChannelListeners killAllChannelOutputs killAllChannels killAllListeners killAllProcedures killAllReceivers killChannel killChannelListenerConsumer killChannelOutputConsumer killListener killListenerConsumer killProcedure killProcedureConsumer killReceiver killReceiverConsumer listener procedure processPendingSubscriptions receiver reconnect send startBatch startBatching stopBatching subscribe subscriptions transmit transmitPublish unsubscribe

Constructors

  • Parameters

    Returns AGClientSocket

Properties

AUTHENTICATED: "authenticated"
CLOSED: "closed"
CONNECTING: "connecting"
OPEN: "open"
PENDING: "pending"
SUBSCRIBED: "subscribed"
UNAUTHENTICATED: "unauthenticated"
UNSUBSCRIBED: "unsubscribed"
ackTimeout: number
auth: AGAuthEngine
authState: AuthStates
authToken: null | AuthToken
authTokenName: string
batchOnHandshake: boolean
batchOnHandshakeDuration: number
channelPrefix: null | string
clientId?: string
connectAttempts: number
connectTimeout: number
disconnectOnUnload: boolean
errorStatuses: SocketProtocolErrorStatuses
id: null | string
ignoreStatuses: SocketProtocolIgnoreStatuses
isBatching: boolean
isBufferingBatch: boolean
options: ClientOptions
pendingReconnect: boolean
pendingReconnectTimeout: number
pingTimeout: number
pingTimeoutDisabled: boolean
poolIndex?: number
preparingPendingSubscriptions: boolean
protocolVersion: ProtocolVersions
signedAuthToken: null | string
state: States
transport?: AGTransport
version: null | string
wsOptions?: ClientOptions

Methods

  • Parameters

    • signedAuthToken: string

    Returns Promise<AuthStatus>

  • Returns void

  • Returns void

  • Parameters

    • channelName: string

    Returns AGChannel<any>

  • Parameters

    • channelName: string

    Returns void

  • Parameters

    • channelName: string
    • eventName: string

    Returns void

  • Parameters

    • channelName: string

    Returns void

  • Parameters

    • channelName: string

    Returns number

  • Parameters

    • channelName: string

    Returns ConsumerStats[]

  • Parameters

    • channelName: string
    • eventName: string

    Returns number

  • Parameters

    • channelName: string
    • eventName: string

    Returns ConsumerStats[]

  • Parameters

    • channelName: string

    Returns number

  • Parameters

    • channelName: string

    Returns ConsumerStats[]

  • Parameters

    • channelName: string
    • consumerId: number

    Returns boolean

  • Parameters

    • channelName: string
    • eventName: string
    • consumerId: number

    Returns boolean

  • Parameters

    • channelName: string
    • consumerId: number

    Returns boolean

  • Parameters

    • channelName: string

    Returns void

  • Parameters

    • channelName: string
    • eventName: string

    Returns void

  • Parameters

    • channelName: string

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Parameters

    • channelName: string

    Returns void

  • Parameters

    • eventName: string

    Returns void

  • Parameters

    • procedureName: string

    Returns void

  • Parameters

    • receiverName: string

    Returns void

  • Returns void

  • Returns Promise<void>

  • Parameters

    • message: any

    Returns any

  • Parameters

    • encodedString: string

    Returns string

  • Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

  • Parameters

    • eventName: "removeAuthToken"
    • data: {
          oldAuthToken: AuthToken;
      }
      • oldAuthToken: AuthToken

    Returns void

  • Parameters

    Returns void

  • Parameters

    • eventName: "connecting"
    • data: {}

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • eventName: "close" | "disconnect" | "connectAbort"
      • data: CloseData

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • object: any

      Returns any

    • Parameters

      • decodedString: string

      Returns string

    • Returns void

    • Returns number

    • Returns any[]

    • Returns number

    • Returns any[]

    • Returns number

    • Returns number

    • Returns ConsumerStats[]

    • Returns number

    • Returns ConsumerStats[]

    • Returns number

    • Returns ConsumerStats[]

    • Returns null | AuthToken

    • Returns number

    • Returns number

    • Parameters

      • channelName: string

      Returns number

    • Parameters

      • consumerId: number

      Returns number

    • Parameters

      • consumerId: number

      Returns ConsumerStats

    • Parameters

      • channelName: string

      Returns object

    • Parameters

      • consumerId: number

      Returns number

    • Parameters

      • consumerId: number

      Returns ConsumerStats

    • Parameters

      • channelName: string

      Returns ChannelState

    • Parameters

      • eventName: string

      Returns number

    • Parameters

      • consumerId: number

      Returns number

    • Parameters

      • consumerId: number

      Returns ConsumerStats

    • Parameters

      • eventName: string

      Returns ConsumerStats[]

    • Parameters

      • procedureName: string

      Returns number

    • Parameters

      • consumerId: number

      Returns number

    • Parameters

      • consumerId: number

      Returns ConsumerStats

    • Parameters

      • procedureName: string

      Returns ConsumerStats[]

    • Parameters

      • receiverName: string

      Returns number

    • Parameters

      • consumerId: number

      Returns number

    • Parameters

      • consumerId: number

      Returns ConsumerStats

    • Parameters

      • receiverName: string

      Returns ConsumerStats[]

    • Returns null | string

    • Returns States

    • Parameters

      • consumerId: any

      Returns boolean

    • Parameters

      • consumerId: any

      Returns boolean

    • Parameters

      • consumerId: number

      Returns boolean

    • Parameters

      • consumerId: number

      Returns boolean

    • Parameters

      • consumerId: number

      Returns boolean

    • Parameters

      • eventName: string
      • consumerId: number

      Returns boolean

    • Parameters

      • procedureName: string
      • consumerId: number

      Returns boolean

    • Parameters

      • receiverName: string
      • consumerId: number

      Returns boolean

    • Parameters

      • event: string
      • data: any
      • Optional options: {
            ackTimeout?: number;
        }
        • Optional ackTimeout?: number

      Returns Promise<any>

    • Parameters

      • channelName: string
      • data: any

      Returns Promise<{
          channel: string;
          data: any;
      }>

    • Parameters

      • channelName: string
      • Optional includePending: boolean

      Returns boolean

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • channelName: string

      Returns void

    • Parameters

      • consumerId: number

      Returns void

    • Parameters

      • consumerId: number

      Returns void

    • Parameters

      • eventName: string

      Returns void

    • Parameters

      • consumerId: number

      Returns void

    • Parameters

      • procedureName: string

      Returns void

    • Parameters

      • consumerId: number

      Returns void

    • Parameters

      • receiverName: string

      Returns void

    • Parameters

      • consumerId: number

      Returns void

    • Parameters

      • eventName: "removeAuthToken"

      Returns ConsumableStream<{
          oldAuthToken: AuthToken;
      }>

    • Parameters

      • eventName: "connect"

      Returns ConsumableStream<ConnectData>

    • Parameters

      • eventName: "connecting"

      Returns ConsumableStream<{}>

    • Parameters

      • eventName: "authStateChange"

      Returns ConsumableStream<AGClientSocket.AuthStateChangeData>

    • Parameters

      • eventName: "authenticate"

      Returns ConsumableStream<AuthenticateData>

    • Parameters

      • eventName: "deauthenticate"

      Returns ConsumableStream<DeauthenticateData>

    • Parameters

      • eventName: "error"

      Returns ConsumableStream<{
          error: Error;
      }>

    • Parameters

      • eventName: "close" | "disconnect" | "connectAbort"

      Returns ConsumableStream<CloseData>

    • Parameters

      • eventName: "subscribeStateChange"

      Returns ConsumableStream<SubscribeStateChangeData>

    • Parameters

      • eventName: "subscribe" | "subscribeRequest"

      Returns ConsumableStream<SubscribeData>

    • Parameters

      • eventName: "subscribeFail"

      Returns ConsumableStream<SubscribeFailData>

    • Parameters

      • eventName: "unsubscribe"

      Returns ConsumableStream<UnsubscribeData>

    • Parameters

      • eventName: "kickOut"

      Returns ConsumableStream<KickOutData>

    • Parameters

      • procedureName: string

      Returns DemuxedConsumableStream<any>

    • Returns void

    • Parameters

      • receiverName: string

      Returns DemuxedConsumableStream<any>

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

    • Parameters

      • data: any

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns AGChannel<any>

    • Parameters

      • Optional includePending: boolean

      Returns string[]

    • Parameters

      • event: string
      • data: any
      • Optional options: {
            ackTimeout?: number;
        }
        • Optional ackTimeout?: number

      Returns Promise<void>

    • Parameters

      • channelName: string
      • data: any

      Returns Promise<void>

    • Parameters

      • channelName: string

      Returns Promise<void>

    Generated using TypeDoc