io.netty.bootstrap

Class Bootstrap

java.lang.Object

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

io.netty.bootstrap.Bootstrap

All Implemented Interfaces:

java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
private static InternalLogger	logger
private java.net.SocketAddress	remoteAddress

Fields inherited from class io.netty.bootstrap.AbstractBootstrap

group

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
ChannelFuture	connect() Connect a Channel to the remote peer.
ChannelFuture	connect(java.net.InetAddress inetHost, int inetPort) Connect a Channel to the remote peer.
ChannelFuture	connect(java.net.SocketAddress remoteAddress) Connect a Channel to the remote peer.
ChannelFuture	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) Connect a Channel to the remote peer.
ChannelFuture	connect(java.lang.String inetHost, int inetPort) Connect a Channel to the remote peer.
private ChannelFuture	doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
private static void	doConnect0(ChannelFuture regFuture, Channel channel, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)
(package private) void	init(Channel channel)
Bootstrap	remoteAddress(java.net.InetAddress inetHost, int inetPort)
Bootstrap	remoteAddress(java.net.SocketAddress remoteAddress) The SocketAddress to connect to once the connect() method is called.
Bootstrap	remoteAddress(java.lang.String inetHost, int inetPort)
java.lang.String	toString()
Bootstrap	validate() Validate all the parameters.

Methods inherited from class io.netty.bootstrap.AbstractBootstrap

attr, attrs, bind, bind, bind, bind, bind, channel, channelFactory, channelFactory, group, group, handler, handler, initAndRegister, localAddress, localAddress, localAddress, localAddress, localAddress, option, options, register

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final InternalLogger logger

remoteAddress

private volatile java.net.SocketAddress remoteAddress

Constructor Detail

Bootstrap

public Bootstrap()

Bootstrap

private Bootstrap(Bootstrap bootstrap)

Method Detail

remoteAddress

public Bootstrap remoteAddress(java.net.SocketAddress remoteAddress)

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

remoteAddress

public Bootstrap remoteAddress(java.lang.String inetHost,
                               int inetPort)

See Also:

#remoteAddress(SocketAddress)}

remoteAddress

public Bootstrap remoteAddress(java.net.InetAddress inetHost,
                               int inetPort)

See Also:

#remoteAddress(SocketAddress)}

connect

public ChannelFuture connect()

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(java.lang.String inetHost,
                             int inetPort)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(java.net.InetAddress inetHost,
                             int inetPort)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress)

Connect a Channel to the remote peer.

connect

public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                             java.net.SocketAddress localAddress)

Connect a Channel to the remote peer.

doConnect

private ChannelFuture doConnect(java.net.SocketAddress remoteAddress,
                                java.net.SocketAddress localAddress)

See Also:

#connect()}

doConnect0

private static void doConnect0(ChannelFuture regFuture,
                               Channel channel,
                               java.net.SocketAddress remoteAddress,
                               java.net.SocketAddress localAddress,
                               ChannelPromise promise)

init

void init(Channel channel)
   throws java.lang.Exception

Specified by:

init in class AbstractBootstrap<Bootstrap,Channel>

Throws:

java.lang.Exception

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.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractBootstrap<Bootstrap,Channel>