/*
 *  Copyright (c) 2011-2015 The original author or authors
 *  ------------------------------------------------------
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *       The Eclipse Public License is available at
 *       http://www.eclipse.org/legal/epl-v10.html
 *
 *       The Apache License v2.0 is available at
 *       http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.stomp;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;

import java.util.Map;

Once a connection to the STOMP server has been made, client receives a StompClientConnection, that let send and receive STOMP frames. 
Author:
Clement Escoffier/**
 * Once a connection to the STOMP server has been made, client receives a {@link StompClientConnection}, that let
 * send and receive STOMP frames.
 *
 * @author <a href="http://escoffier.me">Clement Escoffier</a>
 */
@VertxGen
public interface StompClientConnection {

  
Returns:
the session id./**
   * @return the session id.
   */
  String session();

  
Returns:
the STOMP protocol version negotiated with the server./**
   * @return the STOMP protocol version negotiated with the server.
   */
  String version();

  
Closes the connection without sending the DISCONNECT frame. 
See Also:
disconnect()
disconnect(Handler<AsyncResult<Frame>>)/**
   * Closes the connection without sending the {@code DISCONNECT} frame.
   *
   * @see #disconnect()
   * @see #disconnect(Handler)
   */
  void close();

  
Returns:
the server name./**
   * @return the server name.
   */
  String server();

  
Sends a SEND frame to the server. 
Params:
headers – the headers, must not be null
body –  the body, may be null
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends a {@code SEND} frame to the server.
   *
   * @param headers the headers, must not be {@code null}
   * @param body    the body, may be {@code null}
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> send(Map<String, String> headers, Buffer body);

  
Sends a SEND frame to the server. 
Params:
headers –  the headers, must not be null
body –  the body, may be null
receiptHandler – the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.
Returns:
the current StompClientConnection/**
   * Sends a {@code SEND} frame to the server.
   *
   * @param headers        the headers, must not be {@code null}
   * @param body           the body, may be {@code null}
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       sent frame has been received. The handler receives the sent frame.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection send(Map<String, String> headers, Buffer body, Handler<AsyncResult<Frame>> receiptHandler);

  
Sends a SEND frame to the server to the given destination. The message does not have any other header. 
Params:
destination – the destination, must not be null
body –  the body, may be null
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends a {@code SEND} frame to the server to the given destination. The message does not have any other header.
   *
   * @param destination the destination, must not be {@code null}
   * @param body        the body, may be {@code null}
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame>  send(String destination, Buffer body);

  
Sends a SEND frame to the server to the given destination. The message does not have any other header. 
Params:
destination –  the destination, must not be null
body –  the body, may be null
receiptHandler – the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.
Returns:
the current StompClientConnection/**
   * Sends a {@code SEND} frame to the server to the given destination. The message does not have any other header.
   *
   * @param destination    the destination, must not be {@code null}
   * @param body           the body, may be {@code null}
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       sent frame has been received. The handler receives the sent frame.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection send(String destination, Buffer body, Handler<AsyncResult<Frame>> receiptHandler);

  
Sends the given frame to the server.
Params:
frame – the frame
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends the given frame to the server.
   *
   * @param frame the frame
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame>  send(Frame frame);

  
Sends the given frame to the server.
Params:
frame –          the frame
receiptHandler – the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.
Returns:
the current StompClientConnection/**
   * Sends the given frame to the server.
   *
   * @param frame          the frame
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       sent frame has been received. The handler receives the sent frame.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection send(Frame frame, Handler<AsyncResult<Frame>> receiptHandler);

  
Sends a SEND frame to the server to the given destination. 
Params:
destination – the destination, must not be null
body –  the body, may be null
headers –  the header. The destination header is replaced by the value given to the 
                   destination parameter
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends a {@code SEND} frame to the server to the given destination.
   *
   * @param destination the destination, must not be {@code null}
   * @param body        the body, may be {@code null}
   * @param headers     the header. The {@code destination} header is replaced by the value given to the {@code
   *                    destination} parameter
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame>  send(String destination, Map<String, String> headers, Buffer body);

  
Sends a SEND frame to the server to the given destination. 
Params:
destination –  the destination, must not be null
body –  the body, may be null
headers –  the header. The destination header is replaced by the value given to the 
                      destination parameter
receiptHandler – the handler invoked when the RECEIPT frame associated with the sent frame has been received. The handler receives the sent frame.
Returns:
the current StompClientConnection/**
   * Sends a {@code SEND} frame to the server to the given destination.
   *
   * @param destination    the destination, must not be {@code null}
   * @param body           the body, may be {@code null}
   * @param headers        the header. The {@code destination} header is replaced by the value given to the {@code
   *                       destination} parameter
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       sent frame has been received. The handler receives the sent frame.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection send(String destination, Map<String, String> headers, Buffer body, Handler<AsyncResult<Frame>> receiptHandler);

  
Subscribes to the given destination. This destination is used as subscription id.
Params:
destination – the destination, must not be null
handler –  the handler invoked when a message is received on the given destination. Must not be null.
Returns:
a future resolved with the subscription id when the RECEIPT frame associated with the sent frame has been received/**
   * Subscribes to the given destination. This destination is used as subscription id.
   *
   * @param destination the destination, must not be {@code null}
   * @param handler     the handler invoked when a message is received on the given destination. Must not be {@code null}.
   * @return a future resolved with the subscription id when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<String> subscribe(String destination, Handler<Frame> handler);

  
Subscribes to the given destination. This destination is used as subscription id.
Params:
destination –  the destination, must not be null
handler –  the handler invoked when a message is received on the given destination. Must not be null.
receiptHandler – the handler invoked when the RECEIPT frame associated with the subscription has been received. The handler receives the subscription id.
Returns:
the current StompClientConnection/**
   * Subscribes to the given destination. This destination is used as subscription id.
   *
   * @param destination    the destination, must not be {@code null}
   * @param handler        the handler invoked when a message is received on the given destination. Must not be {@code null}.
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       subscription has been received. The handler receives the subscription id.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection subscribe(String destination, Handler<Frame> handler, Handler<AsyncResult<String>> receiptHandler);

  
Subscribes to the given destination.
Params:
destination – the destination, must not be null.
headers –  the headers to configure the subscription. It may contain the ack header to configure the acknowledgment policy. If the given set of headers contains the id header, this value is used as subscription id.
handler –  the handler invoked when a message is received on the given destination. Must not be null.
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Subscribes to the given destination.
   *
   * @param destination the destination, must not be {@code null}.
   * @param headers     the headers to configure the subscription. It may contain the {@code ack}
   *                    header to configure the acknowledgment policy. If the given set of headers contains the
   *                    {@code id} header, this value is used as subscription id.
   * @param handler     the handler invoked when a message is received on the given destination. Must not be {@code null}.
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<String> subscribe(String destination, Map<String, String> headers, Handler<Frame> handler);

  
Subscribes to the given destination.
Params:
destination –  the destination, must not be null
headers –  the headers to configure the subscription. It may contain the ack header to configure the acknowledgment policy. If the given set of headers contains the id header, this value is used as subscription id.
handler –  the handler invoked when a message is received on the given destination. Must not be null.
receiptHandler – the handler invoked when the RECEIPT frame associated with the subscription has been received. The handler receives the subscription id.
Returns:
the current StompClientConnection/**
   * Subscribes to the given destination.
   *
   * @param destination    the destination, must not be {@code null}
   * @param headers        the headers to configure the subscription. It may contain the {@code ack}
   *                       header to configure the acknowledgment policy. If the given set of headers contains the
   *                       {@code id} header, this value is used as subscription id.
   * @param handler        the handler invoked when a message is received on the given destination. Must not be {@code null}.
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       subscription has been received. The handler receives the subscription id.
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection subscribe(String destination, Map<String, String> headers, Handler<Frame> handler, Handler<AsyncResult<String>> receiptHandler);

  
Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the id header). 
Params:
destination – the destination
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Un-subscribes from the given destination. This method only works if the subscription did not specifies a
   * subscription id (using the {@code id} header).
   *
   * @param destination the destination
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> unsubscribe(String destination);

  
Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the id header). 
Params:
destination –    the destination
receiptHandler – the handler invoked when the RECEIPT frame associated with the un-subscription has been received. The handler receives the sent frame (UNSUBSCRIBE).
Returns:
the current StompClientConnection/**
   * Un-subscribes from the given destination. This method only works if the subscription did not specifies a
   * subscription id (using the {@code id} header).
   *
   * @param destination    the destination
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       un-subscription has been received. The handler receives the sent frame ({@code UNSUBSCRIBE}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection unsubscribe(String destination, Handler<AsyncResult<Frame>> receiptHandler);

  
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. 
Params:
destination – the destination
headers –     the headers
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Un-subscribes from the given destination. This method computes the subscription id as follows. If the given
   * headers contains the {@code id} header, the header value is used. Otherwise the destination is used.
   *
   * @param destination the destination
   * @param headers     the headers
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> unsubscribe(String destination, Map<String, String> headers);

  
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. 
Params:
destination –    the destination
headers –        the headers
receiptHandler – the handler invoked when the RECEIPT frame associated with the un-subscription has been received. The handler receives the sent frame (UNSUBSCRIBE).
Returns:
the current StompClientConnection/**
   * Un-subscribes from the given destination. This method computes the subscription id as follows. If the given
   * headers contains the {@code id} header, the header value is used. Otherwise the destination is used.
   *
   * @param destination    the destination
   * @param headers        the headers
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       un-subscription has been received. The handler receives the sent frame ({@code UNSUBSCRIBE}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection unsubscribe(String destination, Map<String, String> headers, Handler<AsyncResult<Frame>> receiptHandler);

  
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. 
Params:
handler – the handler
Returns:
the current StompClientConnection/**
   * Sets a handler notified when an {@code ERROR} frame is received by the client. The handler receives the {@code
   * ERROR} frame and a reference on the {@link StompClientConnection}.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection}
   */
  StompClientConnection errorHandler(Handler<Frame> handler);

  
Sets a handler notified when the STOMP connection is closed.
Params:
handler – the handler
Returns:
the current StompClientConnection/**
   * Sets a handler notified when the STOMP connection is closed.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection closeHandler(Handler<StompClientConnection> handler);


  
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. 
Params:
handler – the handler
Returns:
the current StompClientConnection receiving the dropped connection./**
   * Sets a handler notified when the server does not respond to a {@code 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.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection} receiving the dropped connection.
   */
  @Fluent
  StompClientConnection connectionDroppedHandler(Handler<StompClientConnection> handler);

  
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.
Params:
handler – the handler
Returns:
the current StompClientConnection/**
   * 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.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection pingHandler(Handler<StompClientConnection> handler);

  
Begins a transaction.
Params:
id –  the transaction id, must not be null
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction begin has been processed by the server. The handler receives the sent frame (BEGIN).
Returns:
the current StompClientConnection/**
   * Begins a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction begin has been processed by the server. The handler receives the sent frame
   *                       ({@code BEGIN}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection beginTX(String id, Handler<AsyncResult<Frame>> receiptHandler);

  
Begins a transaction.
Params:
id – the transaction id, must not be null
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Begins a transaction.
   *
   * @param id the transaction id, must not be {@code null}
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> beginTX(String id);

  
Begins a transaction.
Params:
id –  the transaction id, must not be null
headers – additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Begins a transaction.
   *
   * @param id      the transaction id, must not be {@code null}
   * @param headers additional headers to send to the server. The {@code transaction} header is replaced by the value
   *                passed in the @{code id} parameter
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> beginTX(String id, Map<String, String> headers);

  
Begins a transaction.
Params:
id –  the transaction id, must not be null
headers –  additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction begin has been processed by the server. The handler receives the sent frame (BEGIN).
Returns:
the current StompClientConnection/**
   * Begins a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param headers        additional headers to send to the server. The {@code transaction} header is replaced by the
   *                       value passed in the @{code id} parameter
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction begin has been processed by the server. The handler receives the sent frame
   *                       ({@code BEGIN}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection beginTX(String id, Map<String, String> headers, Handler<AsyncResult<Frame>> receiptHandler);

  
Commits a transaction.
Params:
id – the transaction id, must not be null
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Commits a transaction.
   *
   * @param id the transaction id, must not be {@code null}
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> commit(String id);

  
Commits a transaction.
Params:
id –  the transaction id, must not be null
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction commit has been processed by the server. The handler receives the sent frame (COMMIT).
Returns:
the current StompClientConnection/**
   * Commits a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction commit has been processed by the server. The handler receives the sent frame
   *                       ({@code COMMIT}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection commit(String id, Handler<AsyncResult<Frame>> receiptHandler);

  
Commits a transaction.
Params:
id –  the transaction id, must not be null
headers – additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Commits a transaction.
   *
   * @param id      the transaction id, must not be {@code null}
   * @param headers additional headers to send to the server. The {@code transaction} header is replaced by the
   *                value passed in the @{code id} parameter
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> commit(String id, Map<String, String> headers);

  
Commits a transaction.
Params:
id –  the transaction id, must not be null
headers –  additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction commit has been processed by the server. The handler receives the sent frame (COMMIT).
Returns:
the current StompClientConnection/**
   * Commits a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param headers        additional headers to send to the server. The {@code transaction} header is replaced by the
   *                       value passed in the @{code id} parameter
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction commit has been processed by the server. The handler receives the sent frame
   *                       ({@code COMMIT}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection commit(String id, Map<String, String> headers, Handler<AsyncResult<Frame>> receiptHandler);

  
Aborts a transaction.
Params:
id – the transaction id, must not be null
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Aborts a transaction.
   *
   * @param id the transaction id, must not be {@code null}
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> abort(String id);

  
Aborts a transaction.
Params:
id –  the transaction id, must not be null
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction cancellation has been processed by the server. The handler receives the sent frame (ABORT).
Returns:
the current StompClientConnection/**
   * Aborts a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction cancellation has been processed by the server. The handler receives the sent
   *                       frame ({@code ABORT}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection abort(String id, Handler<AsyncResult<Frame>> receiptHandler);

  
Aborts a transaction.
Params:
id –  the transaction id, must not be null
headers – additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Aborts a transaction.
   *
   * @param id      the transaction id, must not be {@code null}
   * @param headers additional headers to send to the server. The {@code transaction} header is replaced by the
   *                value passed in the @{code id} parameter
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> abort(String id, Map<String, String> headers);

  
Aborts a transaction.
Params:
id –  the transaction id, must not be null
headers –  additional headers to send to the server. The transaction header is replaced by the value passed in the @{code id} parameter
receiptHandler – the handler invoked when the RECEIPT frame associated with the transaction cancellation has been processed by the server. The handler receives the sent frame (ABORT).
Returns:
the current StompClientConnection/**
   * Aborts a transaction.
   *
   * @param id             the transaction id, must not be {@code null}
   * @param headers        additional headers to send to the server. The {@code transaction} header is replaced by the
   *                       value passed in the @{code id} parameter
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       transaction cancellation has been processed by the server. The handler receives the sent
   *                       frame ({@code ABORT}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection abort(String id, Map<String, String> headers, Handler<AsyncResult<Frame>> receiptHandler);

  
Disconnects the client. Unlike the close() method, this method send the DISCONNECT frame to the server. 
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Disconnects the client. Unlike the {@link #close()} method, this method send the {@code DISCONNECT} frame to the
   * server.
   *
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> disconnect();

  
Disconnects the client. Unlike the close() method, this method send the DISCONNECT frame to the server. 
Params:
receiptHandler – the handler invoked when the RECEIPT frame associated with the disconnection has been processed by the server. The handler receives the sent frame (DISCONNECT).
Returns:
the current StompClientConnection/**
   * Disconnects the client. Unlike the {@link #close()} method, this method send the {@code DISCONNECT} frame to the
   * server.
   *
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       disconnection has been processed by the server. The handler receives the sent
   *                       frame ({@code DISCONNECT}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection disconnect(Handler<AsyncResult<Frame>> receiptHandler);

  
Disconnects the client. Unlike the close() method, this method send the DISCONNECT frame to the server. This method lets you customize the DISCONNECT frame. 
Params:
frame – the DISCONNECT frame.
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Disconnects the client. Unlike the {@link #close()} method, this method send the {@code DISCONNECT} frame to the
   * server. This method lets you customize the {@code DISCONNECT} frame.
   *
   * @param frame the {@code DISCONNECT} frame.
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> disconnect(Frame frame);

  
Disconnects the client. Unlike the close() method, this method send the DISCONNECT frame to the server. This method lets you customize the DISCONNECT frame. 
Params:
frame –  the DISCONNECT frame.
receiptHandler – the handler invoked when the RECEIPT frame associated with the disconnection has been processed by the server. The handler receives the sent frame (DISCONNECT).
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Disconnects the client. Unlike the {@link #close()} method, this method send the {@code DISCONNECT} frame to the
   * server. This method lets you customize the {@code DISCONNECT} frame.
   *
   * @param frame          the {@code DISCONNECT} frame.
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       disconnection has been processed by the server. The handler receives the sent
   *                       frame ({@code DISCONNECT}).
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  @Fluent
  StompClientConnection disconnect(Frame frame, Handler<AsyncResult<Frame>> receiptHandler);

  
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. 
Params:
id – the message id of the message to acknowledge
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the
   * client. The {@code id} parameter is the message id received in the frame.
   *
   * @param id the message id of the message to acknowledge
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> ack(String id);

  
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. 
Params:
id –             the message id of the message to acknowledge
receiptHandler – the handler invoked when the RECEIPT frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (ACK).
Returns:
the current StompClientConnection/**
   * Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the
   * client. The {@code id} parameter is the message id received in the frame.
   *
   * @param id             the message id of the message to acknowledge
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       acknowledgment has been processed by the server. The handler receives the sent
   *                       frame ({@code ACK}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection ack(String id, Handler<AsyncResult<Frame>> receiptHandler);

  
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. 
Params:
id – the message id of the message to acknowledge
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client.
   * The {@code id} parameter is the message id received in the frame.
   *
   * @param id the message id of the message to acknowledge
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> nack(String id);

  
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. 
Params:
id –             the message id of the message to acknowledge
receiptHandler – the handler invoked when the RECEIPT frame associated with the non-acknowledgment has been processed by the server. The handler receives the sent frame (NACK).
Returns:
the current StompClientConnection/**
   * Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client.
   * The {@code id} parameter is the message id received in the frame.
   *
   * @param id             the message id of the message to acknowledge
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       non-acknowledgment has been processed by the server. The handler receives the sent
   *                       frame ({@code NACK}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection nack(String id, Handler<AsyncResult<Frame>> receiptHandler);

  
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.
Params:
id –   the message id of the message to acknowledge
txId – the transaction id
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * 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.
   *
   * @param id   the message id of the message to acknowledge
   * @param txId the transaction id
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> ack(String id, String txId);

  
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.
Params:
id –             the message id of the message to acknowledge
txId –           the transaction id
receiptHandler – the handler invoked when the RECEIPT frame associated with the acknowledgment has been processed by the server. The handler receives the sent frame (ACK).
Returns:
the current StompClientConnection/**
   * 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.
   *
   * @param id             the message id of the message to acknowledge
   * @param txId           the transaction id
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       acknowledgment has been processed by the server. The handler receives the sent
   *                       frame ({@code ACK}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection ack(String id, String txId, Handler<AsyncResult<Frame>> receiptHandler);

  
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.
Params:
id –   the message id of the message to acknowledge
txId – the transaction id
Returns:
a future resolved with the sent frame when the RECEIPT frame associated with the sent frame has been received/**
   * 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.
   *
   * @param id   the message id of the message to acknowledge
   * @param txId the transaction id
   * @return a future resolved with the sent frame when the {@code RECEIPT} frame associated with the sent frame has been received
   */
  Future<Frame> nack(String id, String txId);

  
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.
Params:
id –             the message id of the message to acknowledge
txId –           the transaction id
receiptHandler – the handler invoked when the RECEIPT frame associated with the non-acknowledgment has been processed by the server. The handler receives the sent frame (NACK).
Returns:
the current StompClientConnection/**
   * 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.
   *
   * @param id             the message id of the message to acknowledge
   * @param txId           the transaction id
   * @param receiptHandler the handler invoked when the {@code RECEIPT} frame associated with the
   *                       non-acknowledgment has been processed by the server. The handler receives the sent
   *                       frame ({@code NACK}).
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection nack(String id, String txId, Handler<AsyncResult<Frame>> receiptHandler);


  
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 StompClient.receivedFrameHandler(Handler<Frame>), 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. 
Params:
handler – the handler
Returns:
the current StompClientConnection/**
   * 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.
   * <p>
   * Unlike {@link StompClient#receivedFrameHandler(Handler)}, the given handler won't receive the {@code
   * CONNECTED} frame. If a received frame handler is set on the {@link StompClient}, it will be used by all
   * clients connection, so calling this method is useless, except if you want to use a different handler.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection receivedFrameHandler(Handler<Frame> handler);

  
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. 
Params:
handler – the handler
Returns:
the current StompClientConnection/**
   * 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.
   * <p>
   * If a writing frame handler is set on the {@link StompClient}, it will be used by all
   * clients connection, so calling this method is useless, except if you want to use a different handler.
   *
   * @param handler the handler
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection writingFrameHandler(Handler<Frame> handler);

  
Configures the exception handler notified upon TCP-level errors.
Params:
exceptionHandler – the handler
Returns:
the current StompClientConnection/**
   * Configures the exception handler notified upon TCP-level errors.
   *
   * @param exceptionHandler the handler
   * @return the current {@link StompClientConnection}
   */
  @Fluent
  StompClientConnection exceptionHandler(Handler<Throwable> exceptionHandler);

  
Returns whether or not the `CONNECTED` frame has been receive meaning that the Stomp connection is established.
Returns:
true if the connection is established, false otherwise/**
   * Returns whether or not the `CONNECTED` frame has been receive meaning that the Stomp connection is established.
   *
   * @return {@code true} if the connection is established, {@code false} otherwise
   */
  boolean isConnected();
}