Module io.helidon.common.socket
Package io.helidon.common.socket

Class NioSocket

java.lang.Object
io.helidon.common.socket.NioSocket
All Implemented Interfaces:
HelidonSocket, SocketContext, Supplier<byte[]>
Direct Known Subclasses:
TlsNioSocket
public sealed class NioSocket extends Object implements HelidonSocket permits TlsNioSocket
Plain socket based on NIO SocketChannel. This socket uses ByteBuffer for reading and writing.

  • Constructor Details

    • NioSocket

      protected NioSocket(SocketChannel delegate, String childSocketId, String socketId)
      Plain socket.
      Parameters:
      delegate - delegate socket
      childSocketId - channel id
      socketId - server channel id

  • Method Details

    • server

      public static NioSocket server(SocketChannel delegate, String channelId, String serverChannelId)
      Create a new server socket.
      Parameters:
      delegate - underlying socket
      channelId - channel id
      serverChannelId - server channel id
      Returns:
      a new plain socket

    • client

      public static NioSocket client(SocketChannel delegate, String channelId)
      Create a new client socket.
      Parameters:
      delegate - underlying socket
      channelId - channel id
      Returns:
      a new plain socket

    • remotePeer

      public PeerInfo remotePeer()
      Description copied from interface: SocketContext
      Remote peer information.
      Specified by:
      remotePeer in interface SocketContext
      Returns:
      peer info

    • localPeer

      public PeerInfo localPeer()
      Description copied from interface: SocketContext
      Local peer information.
      Specified by:
      localPeer in interface SocketContext
      Returns:
      peer info

    • isSecure

      public boolean isSecure()
      Description copied from interface: SocketContext
      Whether the request is secure.
      Specified by:
      isSecure in interface SocketContext
      Returns:
      whether secure

    • socketId

      public String socketId()
      Description copied from interface: SocketContext
      Main socket id. This is the server socket id for server side, connection id for client side.
      Specified by:
      socketId in interface SocketContext
      Returns:
      socket id

    • childSocketId

      public String childSocketId()
      Description copied from interface: SocketContext
      Child socket id. This is the connection socket id for server side. For client side, this may be additional identification of a request (pipeline id, stream id).
      Specified by:
      childSocketId in interface SocketContext
      Returns:
      child socket id, never null

    • close

      public void close()
      Description copied from interface: HelidonSocket
      Close the underlying socket.
      Specified by:
      close in interface HelidonSocket

    • idle

      public void idle()
      Description copied from interface: HelidonSocket
      Sets the socket to idle mode. Idle mode expects no bytes coming over the socket but keeps reading exactly one byte in case connection is severed. Idle mode should be used in case of client side connection caching.
      Specified by:
      idle in interface HelidonSocket

    • isConnected

      public boolean isConnected()
      Description copied from interface: HelidonSocket
      Check if socket is connected.
      Specified by:
      isConnected in interface HelidonSocket
      Returns:
      true if connected

    • read

      public int read(BufferData buffer)
      Description copied from interface: HelidonSocket
      Read bytes from the socket. This method blocks until at least 1 byte is available.
      Specified by:
      read in interface HelidonSocket
      Parameters:
      buffer - buffer to read to
      Returns:
      number of bytes read

    • write

      public void write(BufferData buffer)
      Description copied from interface: HelidonSocket
      Write teh buffer to the underlying socket. This method blocks until all bytes are written.
      Specified by:
      write in interface HelidonSocket
      Parameters:
      buffer - buffer to write

    • get

      public byte[] get()
      Specified by:
      get in interface Supplier<byte[]>

    • write

      protected int write(ByteBuffer buffer)
      Write to the underlying socket/channel from the provided buffer. The buffer is not flipped.
      Parameters:
      buffer - buffer to write
      Returns:
      number of bytes written

    • read

      protected int read(ByteBuffer buffer)
      Read from the underlying socket/channel into the provided buffer. The buffer is not flipped.
      Parameters:
      buffer - buffer to read to
      Returns:
      number of bytes read