Class Bootstrap

java.lang.Object

io.netty.bootstrap.AbstractBootstrap<Bootstrap, Channel>

io.netty.bootstrap.Bootstrap

All Implemented Interfaces:

Cloneable

public class Bootstrap
extends AbstractBootstrap<Bootstrap, Channel>

A Bootstrap that makes it easy to bootstrap a Channel to use for clients.

The AbstractBootstrap.bind() methods are useful in combination with connectionless transports such as datagram (UDP). For regular TCP connections, please use the provided connect() methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	Bootstrap.ExternalAddressResolver

Nested classes/interfaces inherited from class AbstractBootstrap

AbstractBootstrap.PendingRegistrationPromise

Field Summary

Fields

Modifier and Type	Field	Description
private final BootstrapConfig	config
private boolean	disableResolver
private Bootstrap.ExternalAddressResolver	externalResolver
private static final InternalLogger	logger
private SocketAddress	remoteAddress

Fields inherited from class AbstractBootstrap

group

Constructor Summary

Constructors

Modifier	Constructor	Description
	Bootstrap()
private	Bootstrap(Bootstrap bootstrap)

Method Summary

Modifier and Type	Method	Description
Bootstrap	clone()	Returns a deep clone of this bootstrap which has the identical configuration.
Bootstrap	clone(EventLoopGroup group)	Returns a deep clone of this bootstrap which has the identical configuration except that it uses the given EventLoopGroup.
final BootstrapConfig	config()	Returns the AbstractBootstrapConfig object that can be used to obtain the current config of the bootstrap.
ChannelFuture	connect()	Connect a Channel to the remote peer.
ChannelFuture	connect(String inetHost, int inetPort)	Connect a Channel to the remote peer.
ChannelFuture	connect(InetAddress inetHost, int inetPort)	Connect a Channel to the remote peer.
ChannelFuture	connect(SocketAddress remoteAddress)	Connect a Channel to the remote peer.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect a Channel to the remote peer.
Bootstrap	disableResolver()	Disables address name resolution.
private static void	doConnect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise connectPromise)
private ChannelFuture	doResolveAndConnect(SocketAddress remoteAddress, SocketAddress localAddress)
private ChannelFuture	doResolveAndConnect0(Channel channel, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)
(package private) void	init(Channel channel)
(package private) final SocketAddress	remoteAddress()
Bootstrap	remoteAddress(String inetHost, int inetPort)
Bootstrap	remoteAddress(InetAddress inetHost, int inetPort)
Bootstrap	remoteAddress(SocketAddress remoteAddress)	The SocketAddress to connect to once the connect() method is called.
(package private) final AddressResolverGroup<?>	resolver()
Bootstrap	resolver(AddressResolverGroup<?> resolver)	Sets the NameResolver which will resolve the address of the unresolved named address.
Bootstrap	validate()	Validate all the parameters.

Methods inherited from class AbstractBootstrap

attr, attrs, attrs0, bind, bind, bind, bind, bind, channel, channelFactory, channelFactory, channelFactory, copiedMap, extensionsClassLoader, getInitializerExtensions, group, group, handler, handler, initAndRegister, localAddress, localAddress, localAddress, localAddress, localAddress, newAttributesArray, newAttributesArray, newOptionsArray, newOptionsArray, option, options, options0, register, setAttributes, setChannelOptions, toString

Methods inherited from class Object

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

Field Details

logger

private static final InternalLogger logger

config

private final BootstrapConfig config

externalResolver

private Bootstrap.ExternalAddressResolver externalResolver

disableResolver

private volatile boolean disableResolver

remoteAddress

private volatile SocketAddress remoteAddress

Constructor Details

Bootstrap

public Bootstrap()

Bootstrap

private Bootstrap(Bootstrap bootstrap)

Method Details

resolver

public Bootstrap resolver(AddressResolverGroup<?> resolver)

Sets the NameResolver which will resolve the address of the unresolved named address.

Parameters:

resolver - the NameResolver for this Bootstrap; may be null, in which case a default resolver will be used

See Also:

• DefaultAddressResolverGroup

disableResolver

public Bootstrap disableResolver()

Disables address name resolution. Name resolution may be re-enabled with resolver(AddressResolverGroup)

remoteAddress

public Bootstrap remoteAddress(SocketAddress remoteAddress)

The SocketAddress to connect to once the connect() method is called.

remoteAddress

public Bootstrap remoteAddress(String inetHost,
 int inetPort)

See Also:

• remoteAddress(SocketAddress)

remoteAddress

public Bootstrap remoteAddress(InetAddress inetHost,
 int inetPort)

See Also:

• remoteAddress(SocketAddress)

connect

public ChannelFuture connect()

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(String inetHost,
 int inetPort)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(InetAddress inetHost,
 int inetPort)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(SocketAddress remoteAddress)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress)

Connect a Channel to the remote peer.

doResolveAndConnect

private ChannelFuture doResolveAndConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)

See Also:

• connect()

doResolveAndConnect0

private ChannelFuture doResolveAndConnect0(Channel channel,
 SocketAddress remoteAddress,
 SocketAddress localAddress,
 ChannelPromise promise)

doConnect

private static void doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress,
 ChannelPromise connectPromise)

init

void init(Channel channel)
   throws Throwable

Specified by:

init in class AbstractBootstrap<Bootstrap, Channel>

Throws:

Throwable

validate

public Bootstrap 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<Bootstrap, Channel>

clone

public Bootstrap 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<Bootstrap, Channel>

clone

public Bootstrap clone(EventLoopGroup group)

Returns a deep clone of this bootstrap which has the identical configuration except that it uses the given EventLoopGroup. This method is useful when making multiple Channels with similar settings.

config

public final BootstrapConfig 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<Bootstrap, Channel>

remoteAddress

final SocketAddress remoteAddress()

resolver

final AddressResolverGroup<?> resolver()