Class AbstractBootstrap<B extends AbstractBootstrap<B,C>, C extends Channel>

java.lang.Object

io.netty.bootstrap.AbstractBootstrap<B,C>

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Bootstrap, ServerBootstrap

public abstract class AbstractBootstrap<B extends AbstractBootstrap<B,C>, C extends Channel>
extends Object
implements Cloneable

AbstractBootstrap is a helper class that makes it easy to bootstrap a Channel. It support method-chaining to provide an easy way to configure the AbstractBootstrap.

When not used in a ServerBootstrap context, the bind() methods are useful for connectionless transports such as datagram (UDP).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	AbstractBootstrap.PendingRegistrationPromise

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<AttributeKey<?>, Object>	attrs
private ChannelFactory<? extends C>	channelFactory
private static final boolean	CLOSE_ON_SET_OPTION_FAILURE
private static final Map.Entry<AttributeKey<?>, Object>[]	EMPTY_ATTRIBUTE_ARRAY
private static final Map.Entry<ChannelOption<?>, Object>[]	EMPTY_OPTION_ARRAY
private ClassLoader	extensionsClassLoader
(package private) EventLoopGroup	group
private ChannelHandler	handler
private SocketAddress	localAddress
private final Map<ChannelOption<?>, Object>	options

Constructor Summary

Constructors

Constructor	Description
AbstractBootstrap()
AbstractBootstrap(AbstractBootstrap<B,C> bootstrap)

Method Summary

Modifier and Type	Method	Description
<T> B	attr(AttributeKey<T> key, T value)	Allow to specify an initial attribute of the newly created Channel.
(package private) final Map<AttributeKey<?>, Object>	attrs()
(package private) final Map<AttributeKey<?>, Object>	attrs0()
ChannelFuture	bind()	Create a new Channel and bind it.
ChannelFuture	bind(int inetPort)	Create a new Channel and bind it.
ChannelFuture	bind(String inetHost, int inetPort)	Create a new Channel and bind it.
ChannelFuture	bind(InetAddress inetHost, int inetPort)	Create a new Channel and bind it.
ChannelFuture	bind(SocketAddress localAddress)	Create a new Channel and bind it.
B	channel(Class<? extends C> channelClass)	The Class which is used to create Channel instances from.
(package private) final ChannelFactory<? extends C>	channelFactory()
B	channelFactory(ChannelFactory<? extends C> channelFactory)	Deprecated. Use channelFactory(io.netty.channel.ChannelFactory) instead.
B	channelFactory(ChannelFactory<? extends C> channelFactory)	ChannelFactory which is used to create Channel instances from when calling bind().
abstract B	clone()	Returns a deep clone of this bootstrap which has the identical configuration.
abstract AbstractBootstrapConfig<B,C>	config()	Returns the AbstractBootstrapConfig object that can be used to obtain the current config of the bootstrap.
(package private) static <K,V> Map<K,V>	copiedMap(Map<K,V> map)
private ChannelFuture	doBind(SocketAddress localAddress)
private static void	doBind0(ChannelFuture regFuture, Channel channel, SocketAddress localAddress, ChannelPromise promise)
B	extensionsClassLoader(ClassLoader classLoader)	Load ChannelInitializerExtensions using the given class loader.
(package private) Collection<ChannelInitializerExtension>	getInitializerExtensions()
final EventLoopGroup	group()	Deprecated. Use config() instead.
B	group(EventLoopGroup group)	The EventLoopGroup which is used to handle all the events for the to-be-created Channel
(package private) final ChannelHandler	handler()
B	handler(ChannelHandler handler)	the ChannelHandler to use for serving the requests.
(package private) abstract void	init(Channel channel)
(package private) final ChannelFuture	initAndRegister()
(package private) final SocketAddress	localAddress()
B	localAddress(int inetPort)
B	localAddress(String inetHost, int inetPort)
B	localAddress(InetAddress inetHost, int inetPort)
B	localAddress(SocketAddress localAddress)	The SocketAddress which is used to bind the local "end" to.
(package private) final Map.Entry<AttributeKey<?>, Object>[]	newAttributesArray()
(package private) static Map.Entry<AttributeKey<?>, Object>[]	newAttributesArray(Map<AttributeKey<?>, Object> attributes)
(package private) final Map.Entry<ChannelOption<?>, Object>[]	newOptionsArray()
(package private) static Map.Entry<ChannelOption<?>, Object>[]	newOptionsArray(Map<ChannelOption<?>, Object> options)
<T> B	option(ChannelOption<T> option, T value)	Allow to specify a ChannelOption which is used for the Channel instances once they got created.
(package private) final Map<ChannelOption<?>, Object>	options()
(package private) final Map<ChannelOption<?>, Object>	options0()
ChannelFuture	register()	Create a new Channel and register it with an EventLoop.
private B	self()
(package private) static void	setAttributes(Channel channel, Map.Entry<AttributeKey<?>, Object>[] attrs)
private static void	setChannelOption(Channel channel, ChannelOption<?> option, Object value, InternalLogger logger)
(package private) static void	setChannelOptions(Channel channel, Map.Entry<ChannelOption<?>, Object>[] options, InternalLogger logger)
String	toString()
B	validate()	Validate all the parameters.

Methods inherited from class Object

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

Field Details

CLOSE_ON_SET_OPTION_FAILURE

private static final boolean CLOSE_ON_SET_OPTION_FAILURE

EMPTY_OPTION_ARRAY

private static final Map.Entry<ChannelOption<?>, Object>[] EMPTY_OPTION_ARRAY

EMPTY_ATTRIBUTE_ARRAY

private static final Map.Entry<AttributeKey<?>, Object>[] EMPTY_ATTRIBUTE_ARRAY

group

volatile EventLoopGroup group

channelFactory

private volatile ChannelFactory<? extends C extends Channel> channelFactory

localAddress

private volatile SocketAddress localAddress

options

private final Map<ChannelOption<?>, Object> options

attrs

private final Map<AttributeKey<?>, Object> attrs

handler

private volatile ChannelHandler handler

extensionsClassLoader

private volatile ClassLoader extensionsClassLoader

Constructor Details

AbstractBootstrap

AbstractBootstrap()

AbstractBootstrap

AbstractBootstrap(AbstractBootstrap<B,C> bootstrap)

Method Details

group

public B group(EventLoopGroup group)

The EventLoopGroup which is used to handle all the events for the to-be-created Channel

self

private B self()

channel

public B channel(Class<? extends C> channelClass)

The Class which is used to create Channel instances from. You either use this or channelFactory(io.netty.channel.ChannelFactory) if your Channel implementation has no no-args constructor.

channelFactory

@Deprecated
public B channelFactory(ChannelFactory<? extends C> channelFactory)

Deprecated.

Use channelFactory(io.netty.channel.ChannelFactory) instead.

channelFactory

public B channelFactory(ChannelFactory<? extends C> channelFactory)

ChannelFactory which is used to create Channel instances from when calling bind(). This method is usually only used if channel(Class) is not working for you because of some more complex needs. If your Channel implementation has a no-args constructor, its highly recommend to just use channel(Class) to simplify your code.

localAddress

public B localAddress(SocketAddress localAddress)

The SocketAddress which is used to bind the local "end" to.

localAddress

public B localAddress(int inetPort)

See Also:

• localAddress(SocketAddress)

localAddress

public B localAddress(String inetHost,
 int inetPort)

See Also:

• localAddress(SocketAddress)

localAddress

public B localAddress(InetAddress inetHost,
 int inetPort)

See Also:

• localAddress(SocketAddress)

option

public <T> B option(ChannelOption<T> option,
 T value)

Allow to specify a ChannelOption which is used for the Channel instances once they got created. Use a value of null to remove a previous set ChannelOption.

attr

public <T> B attr(AttributeKey<T> key,
 T value)

Allow to specify an initial attribute of the newly created Channel. If the value is null, the attribute of the specified key is removed.

extensionsClassLoader

public B extensionsClassLoader(ClassLoader classLoader)

Load ChannelInitializerExtensions using the given class loader.

By default, the extensions will be loaded by the same class loader that loaded this bootstrap class.

Parameters:

classLoader - The class loader to use for loading ChannelInitializerExtensions.

Returns:

This bootstrap.

validate

public B validate()

Validate all the parameters. Sub-classes may override this, but should call the super method in that case.

clone

public abstract B clone()

Returns a deep clone of this bootstrap which has the identical configuration. This method is useful when making multiple Channels with similar settings. Please note that this method does not clone the EventLoopGroup deeply but shallowly, making the group a shared resource.

Overrides:

clone in class Object

register

public ChannelFuture register()

Create a new Channel and register it with an EventLoop.

bind

public ChannelFuture bind()

Create a new Channel and bind it.

bind

public ChannelFuture bind(int inetPort)

Create a new Channel and bind it.

bind

public ChannelFuture bind(String inetHost,
 int inetPort)

Create a new Channel and bind it.

bind

public ChannelFuture bind(InetAddress inetHost,
 int inetPort)

Create a new Channel and bind it.

bind

public ChannelFuture bind(SocketAddress localAddress)

Create a new Channel and bind it.

doBind

private ChannelFuture doBind(SocketAddress localAddress)

initAndRegister

final ChannelFuture initAndRegister()

init

abstract void init(Channel channel)
            throws Throwable

Throws:

Throwable

getInitializerExtensions

Collection<ChannelInitializerExtension> getInitializerExtensions()

doBind0

private static void doBind0(ChannelFuture regFuture,
 Channel channel,
 SocketAddress localAddress,
 ChannelPromise promise)

handler

public B handler(ChannelHandler handler)

the ChannelHandler to use for serving the requests.

group

@Deprecated
public final EventLoopGroup group()

Deprecated.

Use config() instead.

Returns the configured EventLoopGroup or null if non is configured yet.

config

public abstract AbstractBootstrapConfig<B,C> config()

Returns the AbstractBootstrapConfig object that can be used to obtain the current config of the bootstrap.

newOptionsArray

final Map.Entry<ChannelOption<?>, Object>[] newOptionsArray()

newOptionsArray

static Map.Entry<ChannelOption<?>, Object>[] newOptionsArray(Map<ChannelOption<?>, Object> options)

newAttributesArray

final Map.Entry<AttributeKey<?>, Object>[] newAttributesArray()

newAttributesArray

static Map.Entry<AttributeKey<?>, Object>[] newAttributesArray(Map<AttributeKey<?>, Object> attributes)

options0

final Map<ChannelOption<?>, Object> options0()

attrs0

final Map<AttributeKey<?>, Object> attrs0()

localAddress

final SocketAddress localAddress()

channelFactory

final ChannelFactory<? extends C> channelFactory()

handler

final ChannelHandler handler()

options

final Map<ChannelOption<?>, Object> options()

attrs

final Map<AttributeKey<?>, Object> attrs()

copiedMap

static <K,V> Map<K,V> copiedMap(Map<K,V> map)

setAttributes

static void setAttributes(Channel channel,
 Map.Entry<AttributeKey<?>, Object>[] attrs)

setChannelOptions

static void setChannelOptions(Channel channel,
 Map.Entry<ChannelOption<?>, Object>[] options,
 InternalLogger logger)
                       throws Throwable

Throws:

Throwable

setChannelOption

private static void setChannelOption(Channel channel,
 ChannelOption<?> option,
 Object value,
 InternalLogger logger)
                              throws Throwable

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object