stompjs@7.0.0, rx-stomp@2.0.0
  1. Classes
  2. StompConfig

File

consolidated/stompjs/src/stomp-config.ts

Description

Configuration options for STOMP Client, each key corresponds to field by the same name in Client. This can be passed to the constructor of Client or to Client#configure.

Part of @stomp/stompjs.

Index

Properties

Properties

Public Optional appendMissingNULLonIncoming
Type : boolean
Defined in consolidated/stompjs/src/stomp-config.ts:68

See Client#appendMissingNULLonIncoming.
Public Optional beforeConnect
Type : function
Defined in consolidated/stompjs/src/stomp-config.ts:103

See Client#beforeConnect.
Public Optional brokerURL
Type : string
Defined in consolidated/stompjs/src/stomp-config.ts:23

See Client#brokerURL.
Public Optional connectHeaders
Type : StompHeaders
Defined in consolidated/stompjs/src/stomp-config.ts:78

See Client#connectHeaders.
Public Optional connectionTimeout
Type : number
Defined in consolidated/stompjs/src/stomp-config.ts:38

See Client#connectionTimeout.
Public Optional debug
Type : debugFnType
Defined in consolidated/stompjs/src/stomp-config.ts:138

See Client#debug.
Public Optional discardWebsocketOnCommFailure
Type : boolean
Defined in consolidated/stompjs/src/stomp-config.ts:143

See Client#discardWebsocketOnCommFailure.
Public Optional disconnectHeaders
Type : StompHeaders
Defined in consolidated/stompjs/src/stomp-config.ts:83

See Client#disconnectHeaders.
Public Optional forceBinaryWSFrames
Type : boolean
Defined in consolidated/stompjs/src/stomp-config.ts:63

See Client#forceBinaryWSFrames.
Public Optional heartbeatIncoming
Type : number
Defined in consolidated/stompjs/src/stomp-config.ts:48

See Client#heartbeatIncoming.
Public Optional heartbeatOutgoing
Type : number
Defined in consolidated/stompjs/src/stomp-config.ts:53

See Client#heartbeatOutgoing.
Public Optional logRawCommunication
Type : boolean
Defined in consolidated/stompjs/src/stomp-config.ts:133

See Client#logRawCommunication.
Public Optional maxWebSocketChunkSize
Type : number
Defined in consolidated/stompjs/src/stomp-config.ts:73

See Client#maxWebSocketChunkSize.
Public Optional onChangeState
Type : function
Defined in consolidated/stompjs/src/stomp-config.ts:148

See Client#onChangeState.
Public Optional onConnect
Type : frameCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:108

See Client#onConnect.
Public Optional onDisconnect
Type : frameCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:113

See Client#onDisconnect.
Public Optional onStompError
Type : frameCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:118

See Client#onStompError.
Public Optional onUnhandledFrame
Type : frameCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:98

See Client#onUnhandledFrame.
Public Optional onUnhandledMessage
Type : messageCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:88

See Client#onUnhandledMessage.
Public Optional onUnhandledReceipt
Type : frameCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:93

See Client#onUnhandledReceipt.
Public Optional onWebSocketClose
Type : closeEventCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:123

See Client#onWebSocketClose.
Public Optional onWebSocketError
Type : wsErrorCallbackType
Defined in consolidated/stompjs/src/stomp-config.ts:128

See Client#onWebSocketError.
Public Optional reconnectDelay
Type : number
Defined in consolidated/stompjs/src/stomp-config.ts:43

See Client#reconnectDelay.
Public Optional splitLargeFrames
Type : boolean
Defined in consolidated/stompjs/src/stomp-config.ts:58

See Client#splitLargeFrames.
Public Optional stompVersions
Type : Versions
Defined in consolidated/stompjs/src/stomp-config.ts:28

See Client#stompVersions.
Public Optional webSocketFactory
Type : function
Defined in consolidated/stompjs/src/stomp-config.ts:33

See Client#webSocketFactory.

 
import { StompHeaders } from './stomp-headers.js';
import {
  ActivationState,
  closeEventCallbackType,
  debugFnType,
  frameCallbackType,
  messageCallbackType,
  wsErrorCallbackType,
} from './types.js';
import { Versions } from './versions.js';

/**
 * Configuration options for STOMP Client, each key corresponds to
 * field by the same name in {@link Client}. This can be passed to
 * the constructor of {@link Client} or to [Client#configure]{@link Client#configure}.
 *
 * Part of `@stomp/stompjs`.
 */
export class StompConfig {
  /**
   * See [Client#brokerURL]{@link Client#brokerURL}.
   */
  public brokerURL?: string;

  /**
   * See [Client#stompVersions]{@link Client#stompVersions}.
   */
  public stompVersions?: Versions;

  /**
   * See [Client#webSocketFactory]{@link Client#webSocketFactory}.
   */
  public webSocketFactory?: () => any;

  /**
   * See [Client#connectionTimeout]{@link Client#connectionTimeout}.
   */
  public connectionTimeout?: number;

  /**
   * See [Client#reconnectDelay]{@link Client#reconnectDelay}.
   */
  public reconnectDelay?: number;

  /**
   * See [Client#heartbeatIncoming]{@link Client#heartbeatIncoming}.
   */
  public heartbeatIncoming?: number;

  /**
   * See [Client#heartbeatOutgoing]{@link Client#heartbeatOutgoing}.
   */
  public heartbeatOutgoing?: number;

  /**
   * See [Client#splitLargeFrames]{@link Client#splitLargeFrames}.
   */
  public splitLargeFrames?: boolean;

  /**
   * See [Client#forceBinaryWSFrames]{@link Client#forceBinaryWSFrames}.
   */
  public forceBinaryWSFrames?: boolean;

  /**
   * See [Client#appendMissingNULLonIncoming]{@link Client#appendMissingNULLonIncoming}.
   */
  public appendMissingNULLonIncoming?: boolean;

  /**
   * See [Client#maxWebSocketChunkSize]{@link Client#maxWebSocketChunkSize}.
   */
  public maxWebSocketChunkSize?: number;

  /**
   * See [Client#connectHeaders]{@link Client#connectHeaders}.
   */
  public connectHeaders?: StompHeaders;

  /**
   * See [Client#disconnectHeaders]{@link Client#disconnectHeaders}.
   */
  public disconnectHeaders?: StompHeaders;

  /**
   * See [Client#onUnhandledMessage]{@link Client#onUnhandledMessage}.
   */
  public onUnhandledMessage?: messageCallbackType;

  /**
   * See [Client#onUnhandledReceipt]{@link Client#onUnhandledReceipt}.
   */
  public onUnhandledReceipt?: frameCallbackType;

  /**
   * See [Client#onUnhandledFrame]{@link Client#onUnhandledFrame}.
   */
  public onUnhandledFrame?: frameCallbackType;

  /**
   * See [Client#beforeConnect]{@link Client#beforeConnect}.
   */
  public beforeConnect?: () => void | Promise<void>;

  /**
   * See [Client#onConnect]{@link Client#onConnect}.
   */
  public onConnect?: frameCallbackType;

  /**
   * See [Client#onDisconnect]{@link Client#onDisconnect}.
   */
  public onDisconnect?: frameCallbackType;

  /**
   * See [Client#onStompError]{@link Client#onStompError}.
   */
  public onStompError?: frameCallbackType;

  /**
   * See [Client#onWebSocketClose]{@link Client#onWebSocketClose}.
   */
  public onWebSocketClose?: closeEventCallbackType;

  /**
   * See [Client#onWebSocketError]{@link Client#onWebSocketError}.
   */
  public onWebSocketError?: wsErrorCallbackType;

  /**
   * See [Client#logRawCommunication]{@link Client#logRawCommunication}.
   */
  public logRawCommunication?: boolean;

  /**
   * See [Client#debug]{@link Client#debug}.
   */
  public debug?: debugFnType;

  /**
   * See [Client#discardWebsocketOnCommFailure]{@link Client#discardWebsocketOnCommFailure}.
   */
  public discardWebsocketOnCommFailure?: boolean;

  /**
   * See [Client#onChangeState]{@link Client#onChangeState}.
   */
  public onChangeState?: (state: ActivationState) => void;
}

results matching ""

    No results matching ""