StompClientConnection | @vertx/stomp

Once a connection to the STOMP server has been made, client receives a StompClientConnection, that let send and receive STOMP frames.

Hierarchy

StompClientConnection

Index

Methods

abort

abort(id: string): PromiseLike<Frame>
abort(id: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
abort(id: string, headers: {}): PromiseLike<Frame>
abort(id: string, headers: {}, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:432
Aborts a transaction.

Parameters
- id: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:437
Aborts a transaction.

Parameters
- id: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:442
Aborts a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:447
Aborts a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

ack

ack(id: string): PromiseLike<Frame>
ack(id: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
ack(id: string, txId: string): PromiseLike<Frame>
ack(id: string, txId: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:477
Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the client. The id parameter is the message id received in the frame.

Parameters
- id: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:483
Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the client. The id parameter is the message id received in the frame.

Parameters
- id: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:501
Sends an acknowledgement for the given frame. It means that the frame has been handled and processed by the client. The sent acknowledgement is part of the transaction identified by the given id.

Parameters
- id: string
- txId: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:507
Sends an acknowledgement for the given frame. It means that the frame has been handled and processed by the client. The sent acknowledgement is part of the transaction identified by the given id.

Parameters
- id: string
- txId: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

beginTX

beginTX(id: string): PromiseLike<Frame>
beginTX(id: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
beginTX(id: string, headers: {}): PromiseLike<Frame>
beginTX(id: string, headers: {}, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:392
Begins a transaction.

Parameters
- id: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:397
Begins a transaction.

Parameters
- id: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:402
Begins a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:407
Begins a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

close

close(): void

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:276
Closes the connection without sending the DISCONNECT frame.

Returns void

closeHandler

closeHandler(handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:374
Sets a handler notified when the STOMP connection is closed.

Parameters
- handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>
Returns StompClientConnection

commit

commit(id: string): PromiseLike<Frame>
commit(id: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
commit(id: string, headers: {}): PromiseLike<Frame>
commit(id: string, headers: {}, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:412
Commits a transaction.

Parameters
- id: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:417
Commits a transaction.

Parameters
- id: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:422
Commits a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:427
Commits a transaction.

Parameters
- id: string
- headers: {}
  - [key: string]: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

connectionDroppedHandler

connectionDroppedHandler(handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:381
Sets a handler notified when the server does not respond to a ping request in time. In other words, this handler is invoked when the heartbeat has detected a connection failure with the server. The handler can decide to reconnect to the server.

Parameters
- handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>
Returns StompClientConnection

disconnect

disconnect(): PromiseLike<Frame>
disconnect(receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
disconnect(frame: Frame): PromiseLike<Frame>
disconnect(frame: Frame, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:453
Disconnects the client. Unlike the {@link StompClientConnection#close} method, this method send the DISCONNECT frame to the server.

Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:459
Disconnects the client. Unlike the {@link StompClientConnection#close} method, this method send the DISCONNECT frame to the server.

Parameters
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:465
Disconnects the client. Unlike the {@link StompClientConnection#close} method, this method send the DISCONNECT frame to the server. This method lets you customize the DISCONNECT frame.

Parameters
- frame: Frame
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:471
Disconnects the client. Unlike the {@link StompClientConnection#close} method, this method send the DISCONNECT frame to the server. This method lets you customize the DISCONNECT frame.

Parameters
- frame: Frame
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

errorHandler

errorHandler(handler: ((res: Frame) => void) | Handler<Frame>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:369
Sets a handler notified when an ERROR frame is received by the client. The handler receives the ERROR frame and a reference on the StompClientConnection.

Parameters
- handler: ((res: Frame) => void) | Handler<Frame>
Returns StompClientConnection

exceptionHandler

exceptionHandler(exceptionHandler: ((res: Throwable) => void) | Handler<Throwable>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:542
Configures the exception handler notified upon TCP-level errors.

Parameters
- exceptionHandler: ((res: Throwable) => void) | Handler<Throwable>
Returns StompClientConnection

isConnected

isConnected(): boolean

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:547
Returns whether or not the CONNECTED frame has been receive meaning that the Stomp connection is established.

Returns boolean

nack

nack(id: string): PromiseLike<Frame>
nack(id: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
nack(id: string, txId: string): PromiseLike<Frame>
nack(id: string, txId: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:489
Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client. The id parameter is the message id received in the frame.

Parameters
- id: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:495
Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client. The id parameter is the message id received in the frame.

Parameters
- id: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:513
Sends a non-acknowledgement for the given frame. It means that the frame has not been handled by the client. The sent non-acknowledgement is part of the transaction identified by the given id.

Parameters
- id: string
- txId: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:519
Sends a non-acknowledgement for the given frame. It means that the frame has not been handled by the client. The sent non-acknowledgement is part of the transaction identified by the given id.

Parameters
- id: string
- txId: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

pingHandler

pingHandler(handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:387
Sets a handler that let customize the behavior when a ping needs to be sent to the server. Be aware that changing the default behavior may break the compliance with the STOMP specification.

Parameters
- handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>
Returns StompClientConnection

receivedFrameHandler

receivedFrameHandler(handler: ((res: Frame) => void) | Handler<Frame>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:528
Configures a received handler that get notified when a STOMP frame is received by the client. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified by the handler.

Unlike {@link StompClient#receivedFrameHandler}, the given handler won't receive the CONNECTED frame. If a received frame handler is set on the StompClient, it will be used by all clients connection, so calling this method is useless, except if you want to use a different handler.

Parameters
- handler: ((res: Frame) => void) | Handler<Frame>
Returns StompClientConnection

send

send(headers: {}, body: Buffer): PromiseLike<Frame>
send(headers: {}, body: Buffer, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
send(destination: string, body: Buffer): PromiseLike<Frame>
send(destination: string, body: Buffer, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
send(frame: Frame): PromiseLike<Frame>
send(frame: Frame, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
send(destination: string, headers: {}, body: Buffer): PromiseLike<Frame>
send(destination: string, headers: {}, body: Buffer, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:285
Sends a SEND frame to the server.

Parameters
- headers: {}
  - [key: string]: string
- body: Buffer
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:290
Sends a SEND frame to the server.

Parameters
- headers: {}
  - [key: string]: string
- body: Buffer
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:295
Sends a SEND frame to the server to the given destination. The message does not have any other header.

Parameters
- destination: string
- body: Buffer
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:300
Sends a SEND frame to the server to the given destination. The message does not have any other header.

Parameters
- destination: string
- body: Buffer
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:305
Sends the given frame to the server.

Parameters
- frame: Frame
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:310
Sends the given frame to the server.

Parameters
- frame: Frame
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:315
Sends a SEND frame to the server to the given destination.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
- body: Buffer
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:320
Sends a SEND frame to the server to the given destination.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
- body: Buffer
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

server

server(): string

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:280
Returns string

session

session(): string

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:267
Returns string

subscribe(destination: string, handler: ((res: Frame) => void) | Handler<Frame>): PromiseLike<string>
subscribe(destination: string, handler: ((res: Frame) => void) | Handler<Frame>, receiptHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): StompClientConnection
subscribe(destination: string, headers: {}, handler: ((res: Frame) => void) | Handler<Frame>): PromiseLike<string>
subscribe(destination: string, headers: {}, handler: ((res: Frame) => void) | Handler<Frame>, receiptHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:325
Subscribes to the given destination. This destination is used as subscription id.

Parameters
- destination: string
- handler: ((res: Frame) => void) | Handler<Frame>
Returns PromiseLike<string>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:330
Subscribes to the given destination. This destination is used as subscription id.

Parameters
- destination: string
- handler: ((res: Frame) => void) | Handler<Frame>
- receiptHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:335
Subscribes to the given destination.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
- handler: ((res: Frame) => void) | Handler<Frame>
Returns PromiseLike<string>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:340
Subscribes to the given destination.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
- handler: ((res: Frame) => void) | Handler<Frame>
- receiptHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns StompClientConnection

unsubscribe

unsubscribe(destination: string): PromiseLike<Frame>
unsubscribe(destination: string, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection
unsubscribe(destination: string, headers: {}): PromiseLike<Frame>
unsubscribe(destination: string, headers: {}, receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:346
Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the id header).

Parameters
- destination: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:352
Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the id header).

Parameters
- destination: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:358
Un-subscribes from the given destination. This method computes the subscription id as follows. If the given headers contains the id header, the header value is used. Otherwise the destination is used.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
Returns PromiseLike<Frame>
- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:364
Un-subscribes from the given destination. This method computes the subscription id as follows. If the given headers contains the id header, the header value is used. Otherwise the destination is used.

Parameters
- destination: string
- headers: {}
  - [key: string]: string
- receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>
Returns StompClientConnection

version

version(): string

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:271
Returns string

writingFrameHandler

writingFrameHandler(handler: ((res: Frame) => void) | Handler<Frame>): StompClientConnection

- Defined in io.vertx/vertx-stomp/target/npm/index.d.ts:537
Configures a handler notified when a frame is going to be written on the wire. This handler can be used from logging, debugging. The handler can modify the received frame.

If a writing frame handler is set on the StompClient, it will be used by all clients connection, so calling this method is useless, except if you want to use a different handler.

Parameters
- handler: ((res: Frame) => void) | Handler<Frame>
Returns StompClientConnection

Hierarchy

Index

Methods

Methods

abort

Parameters

id: string

Returns PromiseLike<Frame>

Parameters

id: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

Parameters

id: string

headers: {}

[key: string]: string

Returns PromiseLike<Frame>

Parameters

id: string

headers: {}

[key: string]: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

ack

Parameters

id: string

Returns PromiseLike<Frame>

Parameters

id: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

Parameters

id: string

txId: string

Returns PromiseLike<Frame>

Parameters

id: string

txId: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

beginTX

Parameters

id: string

Returns PromiseLike<Frame>

Parameters

id: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

Parameters

id: string

headers: {}

[key: string]: string

Returns PromiseLike<Frame>

Parameters

id: string

headers: {}

[key: string]: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

close

Returns void

closeHandler

Parameters

handler: ((res: StompClientConnection) => void) | Handler<StompClientConnection>

Returns StompClientConnection

commit

Parameters

id: string

Returns PromiseLike<Frame>

Parameters

id: string

receiptHandler: ((res: AsyncResult<Frame>) => void) | Handler<AsyncResult<Frame>>

Returns StompClientConnection

Parameters

id: string

headers: {}

[key: string]: string

Returns PromiseLike<Frame>

Parameters

id: string