Interface SocketBinder

All Known Implementing Classes:
AbstractBindingHandler, NIOTransport, TCPNIOBindingHandler, TCPNIOTransport, UDPNIOBindingHandler, UDPNIOTransport

public interface SocketBinder
Common API for Socket based Transports, which are able to bind server Socket to specific address and listen for incoming data.
Author:
Alexey Stashok
  • Method Details

    • bind

      Connection<?> bind(int port) throws IOException
      Binds Transport to the specific port on localhost.
      Parameters:
      port - the port to bind to
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(String host, int port) throws IOException
      Binds Transport to the specific host and port.
      Parameters:
      host - the local host the server will bind to
      port - specific port to bind to
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(String host, int port, int backlog) throws IOException
      Binds Transport to the specific host and port.
      Parameters:
      host - the local host the server will bind to
      port - the port to bind to
      backlog - the maximum length of the queue
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(String host, PortRange portRange, int backlog) throws IOException
      Binds Transport to the specific host, and port within a PortRange.
      Parameters:
      host - the local host the server will bind to
      portRange - PortRange.
      backlog - the maximum length of the queue
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(String host, PortRange portRange, boolean randomStartPort, int backlog) throws IOException
      Binds Transport to the specific host, and port within a PortRange.
      Parameters:
      host - the local host the server will bind to
      portRange - PortRange.
      randomStartPort - if true, a random port in the range will be used as the initial port.
      backlog - the maximum length of the queue
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(SocketAddress socketAddress) throws IOException
      Binds Transport to the specific SocketAddress.
      Parameters:
      socketAddress - the local address the server will bind to
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bind

      Connection<?> bind(SocketAddress socketAddress, int backlog) throws IOException
      Binds Transport to the specific SocketAddress.
      Parameters:
      socketAddress - the local address the server will bind to
      backlog - the maximum length of the queue
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • bindToInherited

      Connection<?> bindToInherited() throws IOException
      Binds the Transport to the channel inherited from the entity that created this Java virtual machine.
      Returns:
      bound Connection
      Throws:
      IOException - if unable to bind i.e. if port already bound
    • unbind

      void unbind(Connection<?> connection)
      Unbinds bound Transport connection.
      Parameters:
      connection - Connection
    • unbindAll

      void unbindAll()
      Unbinds all bound Transport connections.