/*
 * Copyright 2015 Red Hat, Inc.
 *
 *  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.eventbus.bridge.tcp;

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.Vertx;
import io.vertx.core.net.NetServerOptions;
import io.vertx.ext.bridge.BridgeOptions;
import io.vertx.ext.eventbus.bridge.tcp.impl.TcpEventBusBridgeImpl;

TCP EventBus bridge for Vert.x
Author:
Paulo Lopes/**
 * TCP EventBus bridge for Vert.x
 *
 * @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a>
 */
@VertxGen
public interface TcpEventBusBridge {

  static TcpEventBusBridge create(Vertx vertx) {
    return create(vertx, null, null);
  }

  static TcpEventBusBridge create(Vertx vertx, BridgeOptions options) {
    return create(vertx, options, null);
  }

  static TcpEventBusBridge create(Vertx vertx, BridgeOptions options, NetServerOptions netServerOptions) {
    return new TcpEventBusBridgeImpl(vertx, options, netServerOptions,null);
  }
  static TcpEventBusBridge create(Vertx vertx, BridgeOptions options, NetServerOptions netServerOptions,Handler<BridgeEvent> eventHandler) {
    return new TcpEventBusBridgeImpl(vertx, options, netServerOptions,eventHandler);
  }
  
Listen on default port 7000
Returns:
a future of the result/**
   * Listen on default port 7000
   *
   * @return a future of the result
   */
  Future<TcpEventBusBridge> listen();

  
Listen on default port 7000 with a handler to report the state of the socket listen operation.
Params:
handler – the result handler
Returns:
self/**
   * Listen on default port 7000 with a handler to report the state of the socket listen operation.
   * @param handler the result handler
   *
   * @return self
   */
  @Fluent
  TcpEventBusBridge listen(Handler<AsyncResult<TcpEventBusBridge>> handler);

  
Listen on specific port and bind to specific address
Params:
port – tcp port
address – tcp address to the bind
Returns:
a future of the result/**
   * Listen on specific port and bind to specific address
   *
   * @param port tcp port
   * @param address tcp address to the bind
   *
   * @return a future of the result
   */
  Future<TcpEventBusBridge> listen(int port, String address);

  
Listen on specific port and bind to specific address
Params:
port – tcp port
address – tcp address to the bind
handler – the result handler
Returns:
self/**
   * Listen on specific port and bind to specific address
   *
   * @param port tcp port
   * @param address tcp address to the bind
   * @param handler the result handler
   *
   * @return self
   */
  @Fluent
  TcpEventBusBridge listen(int port, String address, Handler<AsyncResult<TcpEventBusBridge>> handler);

  
Listen on specific port
Params:
port – tcp port
Returns:
a future of the result/**
   * Listen on specific port
   *
   * @param port tcp port
   *
   * @return a future of the result
   */
  Future<TcpEventBusBridge> listen(int port);

  
Listen on specific port
Params:
port – tcp port
handler – the result handler
Returns:
self/**
   * Listen on specific port
   *
   * @param port tcp port
   * @param handler the result handler
   *
   * @return self
   */
  @Fluent
  TcpEventBusBridge listen(int port, Handler<AsyncResult<TcpEventBusBridge>> handler);

  
Close the current socket.
Params:
handler – the result handler/**
   * Close the current socket.
   *
   * @param handler the result handler
   */
  void close(Handler<AsyncResult<Void>> handler);

  
Close the current socket.
Returns:
a future of the result/**
   * Close the current socket.
   *
   * @return a future of the result
   */
  Future<Void> close();
}