io.netty.bootstrap

Class AbstractBootstrap<B extends AbstractBootstrap<B,C>,C extends Channel>

java.lang.Object

io.netty.bootstrap.AbstractBootstrap<B,C>

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Bootstrap, ServerBootstrap

public abstract class AbstractBootstrap<B extends AbstractBootstrap<B,C>,C extends Channel>
extends Object
implements Cloneable

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.

When not used in a ServerBootstrap context, the bind() methods are useful for connectionless transports such as datagram (UDP).

Method Summary

Methods

Modifier and Type	Method and Description
<T> B	attr(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) Deprecated. Use channelFactory(io.netty.channel.ChannelFactory) instead.
B	channelFactory(ChannelFactory<? extends C> channelFactory) ChannelFactory which is used to create Channel instances from when calling bind().
abstract B	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.
B	group(EventLoopGroup group) The EventLoopGroup which is used to handle all the events for the to-be-creates Channel
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.
ChannelFuture	register() Create a new Channel and register it with an EventLoop.
String	toString()
B	validate() Validate all the parameters.

Methods inherited from class java.lang.Object

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

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 C> channelClass)

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

channelFactory

@Deprecated
public B channelFactory(ChannelFactory<? extends C> channelFactory)

Deprecated. Use channelFactory(io.netty.channel.ChannelFactory) instead.

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

validate

public B validate()

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

clone

public abstract B 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.

Overrides:

clone in class Object

register

public ChannelFuture register()

Create a new Channel and register it with an EventLoop.

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

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

toString

public String toString()

Overrides:

toString in class Object