Module io.netty5.transport

Package io.netty5.bootstrap

Class Bootstrap

java.lang.Object

io.netty5.bootstrap.AbstractBootstrap<Bootstrap,Channel,ChannelFactory<? extends Channel>>

io.netty5.bootstrap.Bootstrap

All Implemented Interfaces:

Cloneable

public class Bootstrap
extends AbstractBootstrap<Bootstrap,Channel,ChannelFactory<? extends 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	Description
Bootstrap()

Method Summary

Modifier and Type	Method	Description
Bootstrap	channel(Class<? extends Channel> channelClass)	The Class which is used to create Channel instances from.
Bootstrap	channelFactory(ChannelFactory<? extends Channel> channelFactory)	ChannelFactory which is used to create Channel instances from when calling AbstractBootstrap.bind().
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.
BootstrapConfig	config()	Returns the AbstractBootstrapConfig object that can be used to obtain the current config of the bootstrap.
Future<Channel>	connect()	Connect a Channel to the remote peer.
Future<Channel>	connect(String inetHost, int inetPort)	Connect a Channel to the remote peer.
Future<Channel>	connect(InetAddress inetHost, int inetPort)	Connect a Channel to the remote peer.
Future<Channel>	connect(SocketAddress remoteAddress)	Connect a Channel to the remote peer.
Future<Channel>	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect a Channel to the remote peer.
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.
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 io.netty5.bootstrap.AbstractBootstrap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Bootstrap

public Bootstrap()

Method Detail

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

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)

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)

ChannelFactory which is used to create Channel instances from 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) to simplify your code.

connect

public Future<Channel> connect()

Connect a Channel to the remote peer.

connect

public Future<Channel> connect(String inetHost,
                               int inetPort)

Connect a Channel to the remote peer.

connect

public Future<Channel> connect(InetAddress inetHost,
                               int inetPort)

Connect a Channel to the remote peer.

connect

public Future<Channel> connect(SocketAddress remoteAddress)

Connect a Channel to the remote peer.

connect

public Future<Channel> 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,ChannelFactory<? extends 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,ChannelFactory<? extends 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,ChannelFactory<? extends Channel>>