io.netty.bootstrap

Class ServerBootstrap

java.lang.Object

io.netty.bootstrap.ServerBootstrap

All Implemented Interfaces:

Cloneable

public final class ServerBootstrap
extends Object

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
<T> B	attr(io.netty.util.AttributeKey<T> key, T value) Allow to specify an initial attribute of the newly created Channel.
ChannelFuture	bind() Create a new Channel and bind it.
ChannelFuture	bind(InetAddress inetHost, int inetPort) Create a new Channel and bind it.
ChannelFuture	bind(int inetPort) Create a new Channel and bind it.
ChannelFuture	bind(SocketAddress localAddress) Create a new Channel and bind it.
ChannelFuture	bind(String inetHost, int inetPort) Create a new Channel and bind it.
B	channel(Class<? extends C> channelClass) The Class which is used to create Channel instances from.
B	channelFactory(ChannelFactory<? extends C> channelFactory) ChannelFactory which is used to create Channel instances from when calling 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.
EventLoopGroup	group() Return the configured EventLoopGroup or null if non is configured yet.
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).
B	handler(ChannelHandler handler) the ChannelHandler to use for serving the requests.
B	localAddress(InetAddress inetHost, int inetPort)
B	localAddress(int inetPort)
B	localAddress(SocketAddress localAddress) The SocketAddress which is used to bind the local "end" to.
B	localAddress(String inetHost, int inetPort)
<T> B	option(ChannelOption<T> option, T value) Allow to specify a ChannelOption which is used for the Channel instances once they got created.
String	toString()
ServerBootstrap	validate() Validate all the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerBootstrap

public ServerBootstrap()

Method Detail

group

public ServerBootstrap group(EventLoopGroup group)

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

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 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()

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

clone

public ServerBootstrap 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.

toString

public String toString()

channel

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

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

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

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.

handler

public B handler(ChannelHandler handler)

the ChannelHandler to use for serving the requests.

group

public final EventLoopGroup group()

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