Class ServerBootstrap

java.lang.Object

io.netty.bootstrap.AbstractBootstrap<ServerBootstrap, ServerChannel>

io.netty.bootstrap.ServerBootstrap

All Implemented Interfaces:

java.lang.Cloneable

public class ServerBootstrap
extends AbstractBootstrap<ServerBootstrap, ServerChannel>

Bootstrap sub-class which allows easy bootstrap of ServerChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ServerBootstrap.ServerBootstrapAcceptor

Nested classes/interfaces inherited from class AbstractBootstrap

AbstractBootstrap.PendingRegistrationPromise

Field Summary

Fields

Modifier and Type	Field	Description
private final java.util.Map<AttributeKey<?>, java.lang.Object>	childAttrs
private EventLoopGroup	childGroup
private ChannelHandler	childHandler
private final java.util.Map<ChannelOption<?>, java.lang.Object>	childOptions
private final ServerBootstrapConfig	config
private static final InternalLogger	logger

Fields inherited from class AbstractBootstrap

group

Constructor Summary

Constructors

Modifier	Constructor	Description
	ServerBootstrap()
private	ServerBootstrap(ServerBootstrap bootstrap)

Method Summary

Modifier and Type	Method	Description
<T> ServerBootstrap	childAttr(AttributeKey<T> childKey, T value)	Set the specific AttributeKey with the given value on every child Channel.
(package private) final java.util.Map<AttributeKey<?>, java.lang.Object>	childAttrs()
EventLoopGroup	childGroup()	Deprecated. Use config() instead.
(package private) final ChannelHandler	childHandler()
ServerBootstrap	childHandler(ChannelHandler childHandler)	Set the ChannelHandler which is used to serve the request for the Channel's.
<T> ServerBootstrap	childOption(ChannelOption<T> childOption, T value)	Allow to specify a ChannelOption which is used for the Channel instances once they get created (after the acceptor accepted the Channel).
(package private) final java.util.Map<ChannelOption<?>, java.lang.Object>	childOptions()
ServerBootstrap	clone()	Returns a deep clone of this bootstrap which has the identical configuration.
final ServerBootstrapConfig	config()	Returns the AbstractBootstrapConfig object that can be used to obtain the current config of the bootstrap.
ServerBootstrap	group(EventLoopGroup group)	Specify the EventLoopGroup which is used for the parent (acceptor) and the child (client).
ServerBootstrap	group(EventLoopGroup parentGroup, EventLoopGroup childGroup)	Set the EventLoopGroup for the parent (acceptor) and the child (client).
(package private) void	init(Channel channel)
ServerBootstrap	validate()	Validate all the parameters.

Methods inherited from class AbstractBootstrap

attr, attrs, attrs0, bind, bind, bind, bind, bind, channel, channelFactory, channelFactory, channelFactory, copiedMap, extensionsClassLoader, getInitializerExtensions, group, handler, handler, initAndRegister, localAddress, localAddress, localAddress, localAddress, localAddress, newAttributesArray, newAttributesArray, newOptionsArray, newOptionsArray, option, options, options0, register, setAttributes, setChannelOptions, toString

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final InternalLogger logger

childOptions

private final java.util.Map<ChannelOption<?>, java.lang.Object> childOptions

childAttrs

private final java.util.Map<AttributeKey<?>, java.lang.Object> childAttrs

config

private final ServerBootstrapConfig config

childGroup

private volatile EventLoopGroup childGroup

childHandler

private volatile ChannelHandler childHandler

Constructor Details

ServerBootstrap

public ServerBootstrap()

ServerBootstrap

private ServerBootstrap(ServerBootstrap bootstrap)

Method Details

group

public ServerBootstrap group(EventLoopGroup group)

Specify the EventLoopGroup which is used for the parent (acceptor) and the child (client).

Overrides:

group in class AbstractBootstrap<ServerBootstrap, ServerChannel>

group

public ServerBootstrap group(EventLoopGroup parentGroup,
 EventLoopGroup childGroup)

Set the EventLoopGroup for the parent (acceptor) and the child (client). These EventLoopGroup's are used to handle all the events and IO for ServerChannel and Channel's.

Important: Usually this is only useful for advanced use-cases and usually group(EventLoopGroup) is the preferred way to configure the group.

childOption

public <T> ServerBootstrap childOption(ChannelOption<T> childOption,
 T value)

Allow to specify a ChannelOption which is used for the Channel instances once they get created (after the acceptor accepted the Channel). Use a value of null to remove a previous set ChannelOption.

childAttr

public <T> ServerBootstrap childAttr(AttributeKey<T> childKey,
 T value)

Set the specific AttributeKey with the given value on every child Channel. If the value is null the AttributeKey is removed

childHandler

public ServerBootstrap childHandler(ChannelHandler childHandler)

Set the ChannelHandler which is used to serve the request for the Channel's.

init

void init(Channel channel)
   throws java.lang.Throwable

Specified by:

init in class AbstractBootstrap<ServerBootstrap, ServerChannel>

Throws:

java.lang.Throwable

validate

public ServerBootstrap validate()

Description copied from class: AbstractBootstrap

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

Overrides:

validate in class AbstractBootstrap<ServerBootstrap, ServerChannel>

clone

public ServerBootstrap clone()

Description copied from class: AbstractBootstrap

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.

Specified by:

clone in class AbstractBootstrap<ServerBootstrap, ServerChannel>

childGroup

@Deprecated
public EventLoopGroup childGroup()

Deprecated.

Use config() instead.

Return the configured EventLoopGroup which will be used for the child channels or null if non is configured yet.

childHandler

final ChannelHandler childHandler()

childOptions

final java.util.Map<ChannelOption<?>, java.lang.Object> childOptions()

childAttrs

final java.util.Map<AttributeKey<?>, java.lang.Object> childAttrs()

config

public final ServerBootstrapConfig config()

Description copied from class: AbstractBootstrap

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

Specified by:

config in class AbstractBootstrap<ServerBootstrap, ServerChannel>