io.netty.bootstrap

Class ServerBootstrap

java.lang.Object

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

io.netty.bootstrap.ServerBootstrap

All Implemented Interfaces:

Cloneable

public final class ServerBootstrap
extends AbstractBootstrap<ServerBootstrap,ServerChannel>

Bootstrap sub-class which allows easy bootstrap of ServerChannel

Constructor Summary

Constructors

Constructor and Description
ServerBootstrap()

Method Summary

Methods

Modifier and Type	Method and Description
ServerBootstrap	channel(Class<? extends ServerChannel> channelClass) The Class which is used to create Channel instances from.
ServerBootstrap	channelFactory(ServerChannelFactory<? extends ServerChannel> channelFactory) ChannelFactory which is used to create Channel instances from when calling AbstractBootstrap.bind().
<T> ServerBootstrap	childAttr(io.netty.util.AttributeKey<T> childKey, T value) Set the specific AttributeKey with the given value on every child Channel.
EventLoopGroup	childGroup() Return the configured EventLoopGroup which will be used for the child channels or null if non is configured yet.
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).
ServerBootstrap	clone() Returns a deep clone of this bootstrap which has the identical configuration.
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 EventExecutorGroup for the parent (acceptor) and the child (client).
String	toString()
ServerBootstrap	validate() Validate all the parameters.

Methods inherited from class io.netty.bootstrap.AbstractBootstrap

attr, bind, bind, bind, bind, bind, group, handler, localAddress, localAddress, localAddress, localAddress, option, register

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerBootstrap

public ServerBootstrap()

Method Detail

channel

public ServerBootstrap channel(Class<? extends ServerChannel> channelClass)

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

channelFactory

public ServerBootstrap channelFactory(ServerChannelFactory<? extends ServerChannel> channelFactory)

ChannelFactory which is used to create Channel instances from when calling AbstractBootstrap.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) for simplify your code.

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 EventExecutorGroup for the parent (acceptor) and the child (client). These EventExecutorGroup's are used to handle all the events and IO for SocketChannel and Channel's.

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(io.netty.util.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.

childGroup

public EventLoopGroup childGroup()

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

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 EventExecutorGroup deeply but shallowly, making the group a shared resource.

Specified by:

clone in class AbstractBootstrap<ServerBootstrap,ServerChannel>

toString

public String toString()

Overrides:

toString in class AbstractBootstrap<ServerBootstrap,ServerChannel>