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 Summary

Constructors

Modifier	Constructor	Description
protected	NioSocket(SocketChannel delegate, String childSocketId, String socketId)	Plain socket.

Method Summary

Modifier and Type	Method	Description
String	childSocketId()	Child socket id.
static NioSocket	client(SocketChannel delegate, String channelId)	Create a new client socket.
void	close()	Close the underlying socket.
byte[]	get()
void	idle()	Sets the socket to idle mode.
boolean	isConnected()	Check if socket is connected.
boolean	isSecure()	Whether the request is secure.
PeerInfo	localPeer()	Local peer information.
protected int	read(ByteBuffer buffer)	Read from the underlying socket/channel into the provided buffer.
protected int	readNonBlocking(ByteBuffer buffer)	Read from the underlying socket/channel in non-blocking mode.
PeerInfo	remotePeer()	Remote peer information.
static NioSocket	server(SocketChannel delegate, String channelId, String serverChannelId)	Create a new server socket.
String	socketId()	Main socket id.
void	write(BufferData buffer)	Write teh buffer to the underlying socket.
protected int	write(ByteBuffer buffer)	Write to the underlying socket/channel from the provided buffer.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HelidonSocket

protocol, protocolNegotiated

Modifier and Type	Method	Description
default String	protocol()	Protocol that was negotiated.
default boolean	protocolNegotiated()	Whether a protocol was negotiated by the socket (such as ALPN when using TLS).

Methods inherited from interface SocketContext

log, log

Modifier and Type	Method	Description
default void	log(System.Logger logger, System.Logger.Level level, String format, Object... variables)	Log a message with the current SocketContext.socketId() and SocketContext.childSocketId() to have consistent logs mappable to sockets.
default void	log(System.Logger logger, System.Logger.Level level, String format, Throwable t, Object... variables)	Log a message with the current SocketContext.socketId() and SocketContext.childSocketId() to have consistent logs mappable to sockets.

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

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

readNonBlocking

protected int readNonBlocking(ByteBuffer buffer)
                       throws IOException

Read from the underlying socket/channel in non-blocking mode. The original blocking mode is restored before this method returns.

Parameters:

buffer - buffer to read to

Returns:

number of bytes read

Throws:

IOException - in case of an I/O error