io.jarasandha.util.io

Class ByteBufs

java.lang.Object

io.jarasandha.util.io.ByteBufs

public abstract class ByteBufs
extends Object

Created by ashwin.jayaprakash.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_BYTES_BOOLEAN
static int	SIZE_BYTES_CHECKSUM
static int	SIZE_BYTES_INT
static int	SIZE_BYTES_LONG
static int	SIZE_BYTES_SHORT
static io.netty.buffer.ByteBufAllocator	UNPOOLED_HEAP_BASED_ALLOCATOR

Method Summary

Modifier and Type	Method and Description
static long	calculateChecksum(io.netty.buffer.ByteBuf givenByteBuf)
static io.netty.buffer.ByteBuf	compress(io.netty.buffer.ByteBufAllocator allocator, io.netty.buffer.ByteBuf decompressed)
static io.netty.buffer.ByteBuf	decompress(io.netty.buffer.ByteBufAllocator allocator, io.netty.buffer.ByteBuf compressed)
static <R> R	mapAndApply(FileChannel fileChannel, long position, long size, Function<io.netty.buffer.ByteBuf,R> action) Memory-maps the given FileChannel and then wraps the mapped region with ByteBuf and then invokes the "action" with it.
static int	write(FileChannel destination, long positionToWriteTo, long numBytesToWrite, ReadableByteChannel source)
static int	writeChunks(WritableByteChannel destination, io.netty.buffer.ByteBuf data, int chunkWriteSizeBytes)
static int	writeOptimized(WritableByteChannel destination, io.netty.buffer.ByteBuf data, int pow2ChunkWriteSizeBytes) An optimized form of writeChunks(WritableByteChannel, ByteBuf, int) where data is written in chunks that are aligned at the given size.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_BYTES_BOOLEAN

public static final int SIZE_BYTES_BOOLEAN

See Also:

Constant Field Values

SIZE_BYTES_SHORT

public static final int SIZE_BYTES_SHORT

See Also:

Constant Field Values

SIZE_BYTES_INT

public static final int SIZE_BYTES_INT

See Also:

Constant Field Values

SIZE_BYTES_LONG

public static final int SIZE_BYTES_LONG

See Also:

Constant Field Values

SIZE_BYTES_CHECKSUM

public static final int SIZE_BYTES_CHECKSUM

See Also:

Constant Field Values

UNPOOLED_HEAP_BASED_ALLOCATOR

public static final io.netty.buffer.ByteBufAllocator UNPOOLED_HEAP_BASED_ALLOCATOR

Method Detail

mapAndApply

public static <R> R mapAndApply(FileChannel fileChannel,
                                long position,
                                long size,
                                Function<io.netty.buffer.ByteBuf,R> action)
                         throws IOException

Memory-maps the given FileChannel and then wraps the mapped region with ByteBuf and then invokes the "action" with it.

The region is unmapped before exiting from this method and the ReferenceCounted.release() invoked too.

Parameters:

fileChannel -

position -

size -

action - The mapped region is provided to this.

Throws:

IOException

writeOptimized

public static int writeOptimized(@CallerMustRelease
                                 WritableByteChannel destination,
                                 @CallerMustRelease
                                 io.netty.buffer.ByteBuf data,
                                 int pow2ChunkWriteSizeBytes)
                          throws IOException

An optimized form of writeChunks(WritableByteChannel, ByteBuf, int) where data is written in chunks that are aligned at the given size.

The first chunked write may not be aligned if there already is content in the channel.

Same with the last chunked write if it does not fill the entire chunk size.

If destination is a FileChannel then use write(FileChannel, long, long, ReadableByteChannel).

Parameters:

destination -

data -

pow2ChunkWriteSizeBytes - Has to be a power of 2 (typically the page size).

Returns:

Number of bytes that were written.

Throws:

IOException

writeChunks

public static int writeChunks(@CallerMustRelease
                              WritableByteChannel destination,
                              @CallerMustRelease
                              io.netty.buffer.ByteBuf data,
                              int chunkWriteSizeBytes)
                       throws IOException

Parameters:

destination -

data -

chunkWriteSizeBytes -

Returns:

The number of bytes that were written.

Throws:

IOException

write

public static int write(@CallerMustRelease
                        FileChannel destination,
                        long positionToWriteTo,
                        long numBytesToWrite,
                        @CallerMustRelease
                        ReadableByteChannel source)
                 throws IOException

Parameters:

destination - Does not change the FileChannel.position().

positionToWriteTo -

numBytesToWrite -

source -

Returns:

The number of bytes that were written.

Throws:

IOException

compress

public static io.netty.buffer.ByteBuf compress(io.netty.buffer.ByteBufAllocator allocator,
                                               @CallerMustRelease
                                               io.netty.buffer.ByteBuf decompressed)

decompress

public static io.netty.buffer.ByteBuf decompress(io.netty.buffer.ByteBufAllocator allocator,
                                                 @CallerMustRelease
                                                 io.netty.buffer.ByteBuf compressed)

calculateChecksum

public static long calculateChecksum(@CallerMustRelease
                                     io.netty.buffer.ByteBuf givenByteBuf)

Parameters:

givenByteBuf -

Returns:

See Also:

SIZE_BYTES_CHECKSUM