Module io.netty5.transport

Package io.netty5.bootstrap

Class ServerBootstrap

java.lang.Object

io.netty5.bootstrap.AbstractBootstrap<ServerBootstrap,ServerChannel,ServerChannelFactory<? extends ServerChannel>>

io.netty5.bootstrap.ServerBootstrap

All Implemented Interfaces:

Cloneable

public class ServerBootstrap
extends AbstractBootstrap<ServerBootstrap,ServerChannel,ServerChannelFactory<? extends ServerChannel>>

Bootstrap sub-class which allows easy bootstrap of ServerChannel

Constructor Summary

Constructors

Constructor	Description
ServerBootstrap()

Method Summary

Modifier and Type	Method	Description
ServerBootstrap	channel(Class<? extends ServerChannel> channelClass)	The Class which is used to create ServerChannel instances from.
ServerBootstrap	channelFactory(ServerChannelFactory<? extends ServerChannel> channelFactory)	ServerChannelFactory which is used to create Channel instances from when calling AbstractBootstrap.bind().
<T> ServerBootstrap	childAttr(AttributeKey<T> childKey, T value)	Set the specific AttributeKey with the given value on every child Channel.
EventLoopGroup	childGroup()	Deprecated. Use config() instead.
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.
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).
ServerBootstrap	validate()	Validate all the parameters.

Methods inherited from class io.netty5.bootstrap.AbstractBootstrap

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

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

Overrides:

group in class AbstractBootstrap<ServerBootstrap,ServerChannel,ServerChannelFactory<? extends 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.

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.

channel

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

The Class which is used to create ServerChannel 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)

ServerChannelFactory 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) to simplify your code.

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,ServerChannelFactory<? extends 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,ServerChannelFactory<? extends 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.

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,ServerChannelFactory<? extends ServerChannel>>