Module io.helidon.common.socket

Package io.helidon.common.socket

Class SocketWriter

java.lang.Object

io.helidon.common.socket.SocketWriter

All Implemented Interfaces:

DataWriter, AutoCloseable

Direct Known Subclasses:

SmartSocketWriter

public abstract class SocketWriter
extends Object
implements DataWriter

Socket writer (possibly) used from multiple threads, takes care of writing to a single socket.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocketWriter(HelidonSocket socket)	A new socket writer.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this writer.
static SocketWriter	create(HelidonSocket socket)	Create a new socket writer.
static SocketWriter	create(ExecutorService executor, HelidonSocket socket, int writeQueueLength, boolean smartAsyncWrites)	Create a new socket writer.
protected HelidonSocket	socket()	Provides access to the underlying socket.
void	writeNow(BufferData buffer)	Write buffer to underlying transport blocking until the buffer is written.
void	writeNow(BufferData... buffers)	Write buffers to underlying transport blocking until the buffers are written.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.buffers.DataWriter

flush, write, write

Constructor Details

SocketWriter

protected SocketWriter(HelidonSocket socket)

A new socket writer.

Parameters:

socket - socket to write to

Method Details

create

public static SocketWriter create(ExecutorService executor,
 HelidonSocket socket,
 int writeQueueLength,
 boolean smartAsyncWrites)

Create a new socket writer.

Parameters:

executor - executor used to create a thread for asynchronous writes

socket - socket to write to

writeQueueLength - maximal number of queued writes, write operation will block if the queue is full; if set to {code 1} or lower, write queue is disabled and writes are direct to socket (blocking)

smartAsyncWrites - flag to enable smart async writes, see SmartSocketWriter

Returns:

a new socket writer

create

public static SocketWriter create(HelidonSocket socket)

Create a new socket writer.

Parameters:

socket - socket to write to

Returns:

a new socket writer

writeNow

public void writeNow(BufferData... buffers)

Description copied from interface: DataWriter

Write buffers to underlying transport blocking until the buffers are written.

Specified by:

writeNow in interface DataWriter

Parameters:

buffers - buffers to write

writeNow

public void writeNow(BufferData buffer)

Description copied from interface: DataWriter

Write buffer to underlying transport blocking until the buffer is written.

Specified by:

writeNow in interface DataWriter

Parameters:

buffer - buffer to write

close

public void close()

Close this writer. Will attempt to write all enqueued buffers and will stop the thread if created. Does not close the socket.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataWriter

socket

protected HelidonSocket socket()

Provides access to the underlying socket.

Returns:

socket