Package org.apache.qpid.protonj2.client.impl

Class ClientInstance

java.lang.Object
org.apache.qpid.protonj2.client.impl.ClientInstance
All Implemented Interfaces:
AutoCloseable, Client
public final class ClientInstance extends Object implements Client
Container of Connection instances that are all created with the same container parent and therefore share the same container Id.

  • Method Details

    • create

      public static ClientInstance create()
      Returns:
      a newly create ClientInstance that uses default configuration.

    • create

      public static ClientInstance create(ClientOptions options)
      Parameters:
      options - The configuration options to apply to the newly create ClientInstance.
      Returns:
      a newly create ClientInstance that uses the configuration provided.

    • connect

      public Connection connect(String host, int port) throws ClientException
      Description copied from interface: Client
      Connect to the specified host and port, without credentials and with all connection options set to their defaults.

      The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

      Specified by:
      connect in interface Client
      Parameters:
      host - the host to connect to
      port - the port to connect to
      Returns:
      connection, establishment not yet completed
      Throws:
      ClientException - if the Client is closed or an error occurs during connect.

    • connect

      public Connection connect(String host, int port, ConnectionOptions options) throws ClientException
      Description copied from interface: Client
      Connect to the specified host and port, with given connection options.

      The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

      Specified by:
      connect in interface Client
      Parameters:
      host - the host to connect to
      port - the port to connect to
      options - options to use when creating the connection.
      Returns:
      connection, establishment not yet completed
      Throws:
      ClientException - if the Client is closed or an error occurs during connect.

    • connect

      public Connection connect(String host) throws ClientException
      Description copied from interface: Client
      Connect to the specified host, using the default port, without credentials and with all connection options set to their defaults.

      The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

      Specified by:
      connect in interface Client
      Parameters:
      host - the host to connect to
      Returns:
      connection, establishment not yet completed
      Throws:
      ClientException - if the Client is closed or an error occurs during connect.

    • connect

      public Connection connect(String host, ConnectionOptions options) throws ClientException
      Description copied from interface: Client
      Connect to the specified host, using the default port, without credentials and with all connection options set to their defaults.

      The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

      Specified by:
      connect in interface Client
      Parameters:
      host - the host to connect to
      options - options to use when creating the connection.
      Returns:
      connection, establishment not yet completed
      Throws:
      ClientException - if the Client is closed or an error occurs during connect.

    • containerId

      public String containerId()
      Specified by:
      containerId in interface Client
      Returns:
      the container id assigned to this Client instance.

    • close

      public void close()
      Description copied from interface: Client
      Closes all currently open Connection instances created by this client.

      This method blocks and waits for each connection to close in turn using the configured close timeout of the ConnectionOptions that the connection was created with.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Client

    • closeAsync

      public Future<Client> closeAsync()
      Description copied from interface: Client
      Closes all currently open Connection instances created by this client.

      This method does not block and wait for each connection to be closed in turn, instead it returns a future which will be completed once the close of all connections has been completed.

      Specified by:
      closeAsync in interface Client
      Returns:
      a Future that will be completed when all open connections have closed.