org.apache.logging.log4j.core.layout

Interface ByteBufferDestination

All Known Implementing Classes:

AbstractSocketManager, DatagramSocketManager, FileManager, MemoryMappedFileManager, OutputStreamManager, RandomAccessFileManager, RollingFileManager, RollingRandomAccessFileManager, SslSocketManager, TcpSocketManager

public interface ByteBufferDestination

ByteBufferDestination is the destination that Encoders write binary data to. It encapsulates a ByteBuffer and a drain() method the producer can call when the ByteBuffer is full.

This interface allows a producer to write arbitrary amounts of data to a destination.

Since:

2.6

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	drain(java.nio.ByteBuffer buf) Consumes the buffer content and returns a buffer with more available space (which may or may not be the same instance).
java.nio.ByteBuffer	getByteBuffer() Returns the buffer to write to.

Method Detail

getByteBuffer

java.nio.ByteBuffer getByteBuffer()

Returns the buffer to write to.

Returns:

the buffer to write to

drain

java.nio.ByteBuffer drain(java.nio.ByteBuffer buf)

Consumes the buffer content and returns a buffer with more available space (which may or may not be the same instance).

Called by the producer when buffer becomes too full to write to.

Parameters:

buf - the buffer to drain

Returns:

a buffer with more available space (which may or may not be the same instance)