Package io.vertx.mutiny.ext.eventbus.bridge.tcp

Class TcpEventBusBridge

java.lang.Object
io.vertx.mutiny.ext.eventbus.bridge.tcp.TcpEventBusBridge
All Implemented Interfaces:
MutinyDelegate
public class TcpEventBusBridge extends Object implements MutinyDelegate
TCP EventBus bridge for Vert.x

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Paulo Lopes
See Also:
  • TcpEventBusBridge

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TypeArg<TcpEventBusBridge>
    __TYPE_ARG
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TcpEventBusBridge(io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge delegate)
    Create a new instance of TcpEventBusBridge delegating to the given (non-null) instance of TcpEventBusBridge.
    TcpEventBusBridge(Object delegate)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<Void>
    close()
    Close the current socket.
    void
    closeAndAwait()
    Close the current socket.
    TcpEventBusBridge
    closeAndForget()
    Close the current socket.
    static TcpEventBusBridge
    create(Vertx vertx)
     
    static TcpEventBusBridge
    create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options)
     
    static TcpEventBusBridge
    create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options, io.vertx.core.net.NetServerOptions netServerOptions)
     
    static TcpEventBusBridge
    create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options, io.vertx.core.net.NetServerOptions netServerOptions, Consumer<BridgeEvent> eventHandler)
     
    boolean
    equals(Object o)
     
    io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge
    getDelegate()
    Get the delegate instance.
    int
    hashCode()
     
    io.smallrye.mutiny.Uni<TcpEventBusBridge>
    listen()
    Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    io.smallrye.mutiny.Uni<TcpEventBusBridge>
    listen(int port)
    Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    io.smallrye.mutiny.Uni<TcpEventBusBridge>
    listen(int port, String address)
    Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    io.smallrye.mutiny.Uni<TcpEventBusBridge>
    listen(io.vertx.core.net.SocketAddress localAddress)
    Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndAwait()
    Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndAwait(int port)
    Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndAwait(int port, String address)
    Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndAwait(io.vertx.core.net.SocketAddress localAddress)
    Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndForget()
    Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndForget(int port)
    Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndForget(int port, String address)
    Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.
    TcpEventBusBridge
    listenAndForget(io.vertx.core.net.SocketAddress localAddress)
    Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.
    static TcpEventBusBridge
    newInstance(io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge delegate)
    Creates a new instance of the TcpEventBusBridge.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • TcpEventBusBridge

      public TcpEventBusBridge(io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge delegate)
      Create a new instance of TcpEventBusBridge delegating to the given (non-null) instance of TcpEventBusBridge.

    • TcpEventBusBridge

      public TcpEventBusBridge(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • listen

      @CheckReturnValue public io.smallrye.mutiny.Uni<TcpEventBusBridge> listen()
      Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • TcpEventBusBridge.listen()

    • listenAndAwait

      public TcpEventBusBridge listenAndAwait()
      Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a TcpEventBusBridge. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      The operation result
      See Also:
      • TcpEventBusBridge.listen()

    • listenAndForget

      public TcpEventBusBridge listenAndForget()
      Start listening on the port and host as configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method ignores the TcpEventBusBridge result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • TcpEventBusBridge.listen()

    • listen

      @CheckReturnValue public io.smallrye.mutiny.Uni<TcpEventBusBridge> listen(int port, String address)
      Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      port - the tcp port
      address - the local address
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • TcpEventBusBridge.listen(int, String)

    • listenAndAwait

      public TcpEventBusBridge listenAndAwait(int port, String address)
      Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a TcpEventBusBridge. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      port - the tcp port
      address - the local address
      Returns:
      The operation result
      See Also:
      • TcpEventBusBridge.listen(int, String)

    • listenAndForget

      public TcpEventBusBridge listenAndForget(int port, String address)
      Start listening on the specified port and host, ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method ignores the TcpEventBusBridge result or any failure.

      Parameters:
      port - the tcp port
      address - the local address
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • TcpEventBusBridge.listen(int, String)

    • listen

      @CheckReturnValue public io.smallrye.mutiny.Uni<TcpEventBusBridge> listen(int port)
      Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      port - the TCP port
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • TcpEventBusBridge.listen(int)

    • listenAndAwait

      public TcpEventBusBridge listenAndAwait(int port)
      Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a TcpEventBusBridge. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      port - the TCP port
      Returns:
      The operation result
      See Also:
      • TcpEventBusBridge.listen(int)

    • listenAndForget

      public TcpEventBusBridge listenAndForget(int port)
      Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the io.vertx.mutiny.core.net.NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method ignores the TcpEventBusBridge result or any failure.

      Parameters:
      port - the TCP port
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • TcpEventBusBridge.listen(int)

    • listen

      @CheckReturnValue public io.smallrye.mutiny.Uni<TcpEventBusBridge> listen(io.vertx.core.net.SocketAddress localAddress)
      Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      localAddress - the local address to listen on
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • TcpEventBusBridge.listen(SocketAddress)

    • listenAndAwait

      public TcpEventBusBridge listenAndAwait(io.vertx.core.net.SocketAddress localAddress)
      Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method returns a TcpEventBusBridge. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      localAddress - the local address to listen on
      Returns:
      The operation result
      See Also:
      • TcpEventBusBridge.listen(SocketAddress)

    • listenAndForget

      public TcpEventBusBridge listenAndForget(io.vertx.core.net.SocketAddress localAddress)
      Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

      Unlike the bare Vert.x variant, this method ignores the TcpEventBusBridge result or any failure.

      Parameters:
      localAddress - the local address to listen on
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • TcpEventBusBridge.listen(SocketAddress)

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Close the current socket.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • TcpEventBusBridge.close()

    • closeAndAwait

      public void closeAndAwait()
      Close the current socket.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      See Also:
      • TcpEventBusBridge.close()

    • closeAndForget

      public TcpEventBusBridge closeAndForget()
      Close the current socket.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Returns:
      The current instance to chain operations if needed.
      See Also:
      • TcpEventBusBridge.close()

    • create

      public static TcpEventBusBridge create(Vertx vertx)

    • create

      public static TcpEventBusBridge create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options)

    • create

      public static TcpEventBusBridge create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options, io.vertx.core.net.NetServerOptions netServerOptions)

    • create

      public static TcpEventBusBridge create(Vertx vertx, io.vertx.ext.bridge.BridgeOptions options, io.vertx.core.net.NetServerOptions netServerOptions, Consumer<BridgeEvent> eventHandler)

    • newInstance

      public static TcpEventBusBridge newInstance(io.vertx.ext.eventbus.bridge.tcp.TcpEventBusBridge delegate)
      Creates a new instance of the TcpEventBusBridge.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object