com.ibasco.agql.core.util

Class Platform

java.lang.Object

com.ibasco.agql.core.util.Platform

@ApiStatus.Internal
public final class Platform
extends Object

Platform specific implementation

Author:

Rafael Luis Ibasco

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadGroup	DEFAULT_THREAD_GROUP

Method Summary

Modifier and Type	Method and Description
static io.netty.channel.EventLoopGroup	createEventLoopGroup(Class<? extends io.netty.channel.Channel> channelClass, Executor executor, int nThreads) Creates a new EventLoopGroup instance.
static io.netty.channel.EventLoopGroup	createEventLoopGroup(ExecutorService executor, int nThreads, boolean useNative) Creates a new EventLoopGroup instance.
static ThreadGroup	createThreadGroup(Class<?> cls) creeateThreadGroup.
static ThreadGroup	createThreadGroup(Class<?> cls, ThreadGroup parent) creeateThreadGroup.
static Class<? extends io.netty.channel.Channel>	getChannelClass(TransportType type) Retrieves the channel class based on the detected platform
static Class<? extends io.netty.channel.Channel>	getChannelClass(TransportType type, boolean useNativeTransport) Retrieves the channel class based on the detected platform
static Class<? extends io.netty.channel.Channel>	getChannelClass(TransportType type, io.netty.channel.EventLoopGroup group) Retrieves the channel class based on the provided EventLoopGroup.
static Integer	getCoreThreadCount(Options options, ExecutorService executorService) Get the core number of threads specified in Options if available.
static io.netty.channel.EventLoopGroup	getDefaultEventLoopGroup() The global EventLoopGroup shared across all clients by default.
static ExecutorService	getDefaultExecutor() The global ExecutorService used by all clients by default.
static BlockingQueue<Runnable>	getDefaultQueue() getDefaultQueue.
static ThreadFactory	getDefaultThreadFactory() getDefaultThreadFactory.
static io.netty.channel.EventLoopGroup	getOrCreateEventLoopGroup(Class<? extends io.netty.channel.Channel> channelClass, ExecutorService executor, int nThreads)
static io.netty.channel.EventLoopGroup	getOrCreateEventLoopGroup(ExecutorService executor, int nThreads, boolean useNative)
static void	initialize() Initialize platform and properties.
static boolean	isDefaultExecutor(Executor executor) Check if the specified Executor is a shared global executor provided by the library

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THREAD_GROUP

public static final ThreadGroup DEFAULT_THREAD_GROUP

Method Detail

initialize

public static void initialize()

Initialize platform and properties. This can only be called once.

getDefaultExecutor

public static ExecutorService getDefaultExecutor()

The global ExecutorService used by all clients by default. (For internal use only, use at your own risk)

Returns:

The default global ExecutorService

getDefaultQueue

public static BlockingQueue<Runnable> getDefaultQueue()

getDefaultQueue.

Returns:

a BlockingQueue object

getDefaultThreadFactory

public static ThreadFactory getDefaultThreadFactory()

getDefaultThreadFactory.

Returns:

The default ThreadFactory used by this library

isDefaultExecutor

public static boolean isDefaultExecutor(Executor executor)

Check if the specified Executor is a shared global executor provided by the library

Parameters:

executor - The Executor to check

Returns:

true if the Executor is global

getCoreThreadCount

public static Integer getCoreThreadCount(Options options,
                                         ExecutorService executorService)

Get the core number of threads specified in Options if available. If not specified in options, it will attempt to detect it via heuristics.

Parameters:

options - The Options instance to be used as lookup

executorService - The ExecutorService to be used for reference in-case value is not specified in the provided Options

Returns:

The core number of threads to be used by the EventLoopGroup

Throws:

IllegalStateException - If the number of core threads could not be determined.

getDefaultEventLoopGroup

public static io.netty.channel.EventLoopGroup getDefaultEventLoopGroup()

The global EventLoopGroup shared across all clients by default. Upon shutdown, the default executor will also be automatically closed.

Returns:

The global EventLoopGroup

createEventLoopGroup

public static io.netty.channel.EventLoopGroup createEventLoopGroup(ExecutorService executor,
                                                                   int nThreads,
                                                                   boolean useNative)

Creates a new EventLoopGroup instance. The default is NioEventLoopGroup

Parameters:

executor - The Executor to be used by the EventLoopGroup

nThreads - The number of threads to be used by the EventLoopGroup. If a custom Executor is provided, then the value should be less than or equals to the maximum number of threads supported by the provided Executor. Set to 0 to use the value defined in system property -Dio.netty.eventLoopThreads (if present) or the default value defined by netty (num of processors x 2).

useNative - true to use native transports when available (e.g. epoll for linux, kqueue for osx).

Returns:

A new EventLoopGroup instance

createEventLoopGroup

public static io.netty.channel.EventLoopGroup createEventLoopGroup(Class<? extends io.netty.channel.Channel> channelClass,
                                                                   Executor executor,
                                                                   int nThreads)

Creates a new EventLoopGroup instance. The default is NioEventLoopGroup

Parameters:

channelClass - The netty channel Class that will be used as a referece to lookup the EventLoopGroup

executor - The Executor to be used by the EventLoopGroup

nThreads - The number of threads to be used by the EventLoopGroup. If a custom Executor is provided, then the value should be less than or equals to the maximum number of threads supported by the provided Executor. Set to 0 to use the value defined in system property -Dio.netty.eventLoopThreads (if present) or the default value defined by netty (num of processors x 2).

Returns:

A new EventLoopGroup instance

Throws:

IllegalStateException - If channelClass is not supported

IllegalArgumentException - If channelClass is null

getOrCreateEventLoopGroup

public static io.netty.channel.EventLoopGroup getOrCreateEventLoopGroup(Class<? extends io.netty.channel.Channel> channelClass,
                                                                        ExecutorService executor,
                                                                        int nThreads)

getOrCreateEventLoopGroup

public static io.netty.channel.EventLoopGroup getOrCreateEventLoopGroup(ExecutorService executor,
                                                                        int nThreads,
                                                                        boolean useNative)

createThreadGroup

public static ThreadGroup createThreadGroup(Class<?> cls)

creeateThreadGroup.

Parameters:

cls - a Class object

Returns:

a ThreadGroup object

createThreadGroup

public static ThreadGroup createThreadGroup(Class<?> cls,
                                            ThreadGroup parent)

creeateThreadGroup.

Parameters:

cls - a Class object

parent - a ThreadGroup object

Returns:

a ThreadGroup object

getChannelClass

public static Class<? extends io.netty.channel.Channel> getChannelClass(TransportType type,
                                                                        io.netty.channel.EventLoopGroup group)

Retrieves the channel class based on the provided EventLoopGroup.

Parameters:

type - a TransportType object

group - a EventLoopGroup object

Returns:

a Class object

getChannelClass

public static Class<? extends io.netty.channel.Channel> getChannelClass(TransportType type)

Retrieves the channel class based on the detected platform

Parameters:

type - a TransportType

Returns:

a Class object

getChannelClass

public static Class<? extends io.netty.channel.Channel> getChannelClass(TransportType type,
                                                                        boolean useNativeTransport)

Retrieves the channel class based on the detected platform

Parameters:

type - a TransportType object

useNativeTransport - true to use native transport

Returns:

a Class object