org.waarp.common.utility

Class WaarpNettyUtil

java.lang.Object

org.waarp.common.utility.WaarpNettyUtil

public final class WaarpNettyUtil
extends Object

Utility class for Netty usage

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMAL_DELAY_MS Minimal delay (OS sleep minimal time)
static int	SIMPLE_DELAY_MS Used in final operation to wait for extra works

Method Summary

Modifier and Type	Method and Description
static boolean	availablePort(int port) Checks to see if a specific port is available.
static boolean	availablePort(int port, InetAddress localAddress) Checks to see if a specific port is available.
static boolean	awaitIsSuccessOfInterrupted(io.netty.util.concurrent.Future<?> future)
static boolean	awaitOrInterrupted(io.netty.util.concurrent.Future<?> future)
static boolean	awaitOrInterrupted(io.netty.util.concurrent.Future<?> future, long timeMilliseconds)
static boolean	release(io.netty.buffer.ByteBuf byteBuf) Shortcut to release a ByteByf
static void	releaseCompletely(io.netty.buffer.ByteBuf byteBuf) Shortcut to release completely a ByteByf
static void	retain(io.netty.buffer.ByteBuf byteBuf) Retain this ByteBuf
static void	setBootstrap(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.EventLoopGroup group, int timeout) Add default configuration for client bootstrap
static void	setBootstrap(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.EventLoopGroup group, int timeout, int maxBufSize, boolean autoRead) Add default configuration for client bootstrap
static void	setServerBootstrap(io.netty.bootstrap.ServerBootstrap bootstrap, io.netty.channel.EventLoopGroup parentGroup, io.netty.channel.EventLoopGroup childGroup, int timeout) Add default configuration for server bootstrap
static void	setServerBootstrap(io.netty.bootstrap.ServerBootstrap bootstrap, io.netty.channel.EventLoopGroup parentGroup, io.netty.channel.EventLoopGroup childGroup, int timeout, int maxBufSize, boolean autoRead) Add default configuration for server bootstrap
static io.netty.buffer.ByteBuf	slice(io.netty.buffer.ByteBuf byteBuf, int start, int size) Utility method to return a ByteBuf slice with Write ready.
static io.netty.buffer.ByteBuf	wrappedBuffer(byte[]... arrays) Use the best approach

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_DELAY_MS

public static final int SIMPLE_DELAY_MS

Used in final operation to wait for extra works

See Also:

Constant Field Values

MINIMAL_DELAY_MS

public static final int MINIMAL_DELAY_MS

Minimal delay (OS sleep minimal time)

See Also:

Constant Field Values

Method Detail

setBootstrap

public static void setBootstrap(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.EventLoopGroup group,
                                int timeout)

Add default configuration for client bootstrap

Parameters:

bootstrap -

group -

timeout -

setBootstrap

public static void setBootstrap(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.EventLoopGroup group,
                                int timeout,
                                int maxBufSize,
                                boolean autoRead)

Add default configuration for client bootstrap

Parameters:

bootstrap -

group -

timeout -

maxBufSize -

autoRead -

setServerBootstrap

public static void setServerBootstrap(io.netty.bootstrap.ServerBootstrap bootstrap,
                                      io.netty.channel.EventLoopGroup parentGroup,
                                      io.netty.channel.EventLoopGroup childGroup,
                                      int timeout)

Add default configuration for server bootstrap

Parameters:

bootstrap -

parentGroup -

childGroup -

timeout -

setServerBootstrap

public static void setServerBootstrap(io.netty.bootstrap.ServerBootstrap bootstrap,
                                      io.netty.channel.EventLoopGroup parentGroup,
                                      io.netty.channel.EventLoopGroup childGroup,
                                      int timeout,
                                      int maxBufSize,
                                      boolean autoRead)

Add default configuration for server bootstrap

Parameters:

bootstrap -

parentGroup -

childGroup -

timeout -

maxBufSize -

autoRead -

availablePort

public static boolean availablePort(int port)

Checks to see if a specific port is available.

Parameters:

port - the port to check for availability

availablePort

public static boolean availablePort(int port,
                                    InetAddress localAddress)

Checks to see if a specific port is available.

Parameters:

port - the port to check for availability

localAddress - the associated localAddress to use

awaitOrInterrupted

public static boolean awaitOrInterrupted(io.netty.util.concurrent.Future<?> future)

Parameters:

future -

Returns:

True if await done, else interruption occurs

awaitOrInterrupted

public static boolean awaitOrInterrupted(io.netty.util.concurrent.Future<?> future,
                                         long timeMilliseconds)

Parameters:

future -

timeMilliseconds -

Returns:

True if await done, else interruption occurs

awaitIsSuccessOfInterrupted

public static boolean awaitIsSuccessOfInterrupted(io.netty.util.concurrent.Future<?> future)

Parameters:

future -

Returns:

True if await and isSuccess, else interruption or not success occurs

release

public static boolean release(io.netty.buffer.ByteBuf byteBuf)

Shortcut to release a ByteByf

Parameters:

byteBuf -

Returns:

True if the ByteBuf is released

releaseCompletely

public static void releaseCompletely(io.netty.buffer.ByteBuf byteBuf)

Shortcut to release completely a ByteByf

Parameters:

byteBuf -

retain

public static void retain(io.netty.buffer.ByteBuf byteBuf)

Retain this ByteBuf

Parameters:

byteBuf -

slice

public static io.netty.buffer.ByteBuf slice(io.netty.buffer.ByteBuf byteBuf,
                                            int start,
                                            int size)

Utility method to return a ByteBuf slice with Write ready. No retain is called on this slice.

Parameters:

byteBuf -

start -

size -

Returns:

the ByteBuf sliced

wrappedBuffer

public static io.netty.buffer.ByteBuf wrappedBuffer(byte[]... arrays)

Use the best approach

Parameters:

arrays -

Returns:

the ByteBuf corresponding to byte arrays