Module io.helidon.common.socket

Package io.helidon.common.socket

Interface HelidonSocket

All Superinterfaces:

SocketContext, Supplier<byte[]>

All Known Implementing Classes:

PlainSocket, TlsSocket

public interface HelidonSocket
extends SocketContext, Supplier<byte[]>

Socket abstraction to allow usage of TLS or even non-socket transport.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying socket.
default String	protocol()	Protocol that was negotiated.
default boolean	protocolNegotiated()	Whether a protocol was negotiated by the socket (such as ALPN when using TLS).
int	read(BufferData buffer)	Read bytes from the socket.
void	write(BufferData buffer)	Write teh buffer to the underlying socket.

Methods inherited from interface io.helidon.common.socket.SocketContext

childSocketId, isSecure, localPeer, log, log, remotePeer, socketId

Methods inherited from interface java.util.function.Supplier

get

Method Details

close

void close()

Close the underlying socket.

read

int read(BufferData buffer)

Read bytes from the socket. This method blocks until at least 1 byte is available.

Parameters:

buffer - buffer to read to

Returns:

number of bytes read

write

void write(BufferData buffer)

Write teh buffer to the underlying socket. This method blocks until all bytes are written.

Parameters:

buffer - buffer to write

protocolNegotiated

default boolean protocolNegotiated()

Whether a protocol was negotiated by the socket (such as ALPN when using TLS).

Returns:

whether a protocol was negotiated

protocol

default String protocol()

Protocol that was negotiated.

Returns:

protocol name

Throws:

NoSuchElementException - in case there is no negotiated protocol