io.netty.bootstrap

Class Bootstrap

java.lang.Object

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

io.netty.bootstrap.Bootstrap

All Implemented Interfaces:

Cloneable

public final 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.

Constructor Summary

Constructors

Constructor and Description
Bootstrap()

Method Summary

Methods

Modifier and Type	Method and Description
Bootstrap	channel(Class<? extends Channel> channelClass) The Class which is used to create Channel instances from.
Bootstrap	channelFactory(ChannelFactory<? extends Channel> channelFactory) ServerChannelFactory which is used to create ServerChannel instances when calling AbstractBootstrap.bind().
Bootstrap	clone() Returns a deep clone of this bootstrap which has the identical configuration.
ChannelFuture	connect() 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.
ChannelFuture	connect(String inetHost, int inetPort) Connect a Channel to the remote peer.
Bootstrap	remoteAddress(InetAddress inetHost, int inetPort)
Bootstrap	remoteAddress(SocketAddress remoteAddress) The SocketAddress to connect to once the connect() method is called.
Bootstrap	remoteAddress(String inetHost, int inetPort)
String	toString()
Bootstrap	validate() Validate all the parameters.

Methods inherited from class io.netty.bootstrap.AbstractBootstrap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Bootstrap

public Bootstrap()

Method Detail

channel

public Bootstrap 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 Bootstrap channelFactory(ChannelFactory<? extends Channel> channelFactory)

ServerChannelFactory which is used to create ServerChannel instances 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) for simplify your code.

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.

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 EventExecutorGroup deeply but shallowly, making the group a shared resource.

Specified by:

clone in class AbstractBootstrap<Bootstrap,Channel>

toString

public String toString()

Overrides:

toString in class AbstractBootstrap<Bootstrap,Channel>