stomp-handler.d.ts 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. import { Client } from './client.js';
  2. import { ITransaction } from './i-transaction.js';
  3. import { StompHeaders } from './stomp-headers.js';
  4. import { StompSubscription } from './stomp-subscription.js';
  5. import { closeEventCallbackType, debugFnType, frameCallbackType, IPublishParams, IStompSocket, IStomptHandlerConfig, messageCallbackType, wsErrorCallbackType } from './types.js';
  6. import { Versions } from './versions.js';
  7. /**
  8. * The STOMP protocol handler
  9. *
  10. * Part of `@stomp/stompjs`.
  11. *
  12. * @internal
  13. */
  14. export declare class StompHandler {
  15. private _client;
  16. _webSocket: IStompSocket;
  17. debug: debugFnType;
  18. stompVersions: Versions;
  19. connectHeaders: StompHeaders;
  20. disconnectHeaders: StompHeaders;
  21. heartbeatIncoming: number;
  22. heartbeatOutgoing: number;
  23. onUnhandledMessage: messageCallbackType;
  24. onUnhandledReceipt: frameCallbackType;
  25. onUnhandledFrame: frameCallbackType;
  26. onConnect: frameCallbackType;
  27. onDisconnect: frameCallbackType;
  28. onStompError: frameCallbackType;
  29. onWebSocketClose: closeEventCallbackType;
  30. onWebSocketError: wsErrorCallbackType;
  31. logRawCommunication: boolean;
  32. splitLargeFrames: boolean;
  33. maxWebSocketChunkSize: number;
  34. forceBinaryWSFrames: boolean;
  35. appendMissingNULLonIncoming: boolean;
  36. discardWebsocketOnCommFailure: boolean;
  37. get connectedVersion(): string | undefined;
  38. private _connectedVersion;
  39. get connected(): boolean;
  40. private _connected;
  41. private readonly _subscriptions;
  42. private readonly _receiptWatchers;
  43. private _partialData;
  44. private _escapeHeaderValues;
  45. private _counter;
  46. private _pinger;
  47. private _ponger;
  48. private _lastServerActivityTS;
  49. constructor(_client: Client, _webSocket: IStompSocket, config: IStomptHandlerConfig);
  50. start(): void;
  51. private readonly _serverFrameHandlers;
  52. private _setupHeartbeat;
  53. private _closeOrDiscardWebsocket;
  54. forceDisconnect(): void;
  55. _closeWebsocket(): void;
  56. discardWebsocket(): void;
  57. private _transmit;
  58. dispose(): void;
  59. private _cleanUp;
  60. publish(params: IPublishParams): void;
  61. watchForReceipt(receiptId: string, callback: frameCallbackType): void;
  62. subscribe(destination: string, callback: messageCallbackType, headers?: StompHeaders): StompSubscription;
  63. unsubscribe(id: string, headers?: StompHeaders): void;
  64. begin(transactionId: string): ITransaction;
  65. commit(transactionId: string): void;
  66. abort(transactionId: string): void;
  67. ack(messageId: string, subscriptionId: string, headers?: StompHeaders): void;
  68. nack(messageId: string, subscriptionId: string, headers?: StompHeaders): void;
  69. }