io.netty.bootstrap

Class AbstractBootstrap<B extends AbstractBootstrap<?>>

java.lang.Object

io.netty.bootstrap.AbstractBootstrap<B>

Direct Known Subclasses:

Bootstrap, ServerBootstrap

public abstract class AbstractBootstrap<B extends AbstractBootstrap<?>>
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractBootstrap.ChannelFactory Factory that is responsible to create new Channel's on bind() requests.

Constructor Summary

Constructors

Constructor and Description
AbstractBootstrap()

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.
protected Map<io.netty.util.AttributeKey<?>,Object>	attrs()
ChannelFuture	bind() Create a new Channel and bind it.
abstract ChannelFuture	bind(ChannelFuture future) Bind the Channel of the given AbstractBootstrap.ChannelFactory.
B	channel(Class<? extends Channel> channelClass) The Class which is used to create Channel instances from.
B	channelFactory(AbstractBootstrap.ChannelFactory factory) AbstractBootstrap.ChannelFactory which is used to create Channel instances from when calling bind().
protected static boolean	ensureOpen(ChannelFuture future)
protected AbstractBootstrap.ChannelFactory	factory()
protected EventLoopGroup	group()
B	group(EventLoopGroup group) The EventLoopGroup which is used to handle all the events for the to-be-creates Channel
protected ChannelHandler	handler()
B	handler(ChannelHandler handler) the ChannelHandler to use for serving the requests.
protected SocketAddress	localAddress()
B	localAddress(InetAddress host, int port) See localAddress(SocketAddress)
B	localAddress(int port) See localAddress(SocketAddress)
B	localAddress(SocketAddress localAddress) The SocketAddress which is used to bind the local "end" to.
B	localAddress(String host, int port) See localAddress(SocketAddress)
<T> B	option(ChannelOption<T> option, T value) Allow to specify a ChannelOption which is used for the Channel instances once they got created.
protected Map<ChannelOption<?>,Object>	options()
void	shutdown() Shutdown the AbstractBootstrap and the EventLoopGroup which is used by it.
protected void	validate() Validate all the parameters.
protected void	validate(ChannelFuture future)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBootstrap

public AbstractBootstrap()

Method Detail

group

public B group(EventLoopGroup group)

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

channel

public B channel(Class<? extends Channel> 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(AbstractBootstrap.ChannelFactory factory)

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

See localAddress(SocketAddress)

localAddress

public B localAddress(String host,
             int port)

See localAddress(SocketAddress)

localAddress

public B localAddress(InetAddress host,
             int port)

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

shutdown

public void shutdown()

Shutdown the AbstractBootstrap and the EventLoopGroup which is used by it. Only call this if you don't share the EventLoopGroup between different AbstractBootstrap's.

validate

protected void validate()

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

validate

protected final void validate(ChannelFuture future)

bind

public ChannelFuture bind()

Create a new Channel and bind it.

handler

public B handler(ChannelHandler handler)

the ChannelHandler to use for serving the requests.

ensureOpen

protected static boolean ensureOpen(ChannelFuture future)

bind

public abstract ChannelFuture bind(ChannelFuture future)

Bind the Channel of the given AbstractBootstrap.ChannelFactory.

localAddress

protected final SocketAddress localAddress()

factory

protected final AbstractBootstrap.ChannelFactory factory()

handler

protected final ChannelHandler handler()

group

protected final EventLoopGroup group()

options

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

attrs

protected final Map<io.netty.util.AttributeKey<?>,Object> attrs()