Package io.netty.channel.embedded

Class EmbeddedChannel.Builder

java.lang.Object

io.netty.channel.embedded.EmbeddedChannel.Builder

Enclosing class:

EmbeddedChannel

public static final class EmbeddedChannel.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
EmbeddedChannel	build()	Create the channel.
EmbeddedChannel.Builder	channelId(ChannelId channelId)	The ChannelId that will be used to identify this channel.
EmbeddedChannel.Builder	config(ChannelConfig config)	The ChannelConfig which will be returned by EmbeddedChannel.config().
EmbeddedChannel.Builder	handlers(ChannelHandler handler)	The ChannelHandler which will be added to the ChannelPipeline.
EmbeddedChannel.Builder	handlers(ChannelHandler... handlers)	The ChannelHandlers which will be added to the ChannelPipeline.
EmbeddedChannel.Builder	hasDisconnect(boolean hasDisconnect)	false if this Channel will delegate EmbeddedChannel.disconnect() to EmbeddedChannel.close(), true otherwise.
EmbeddedChannel.Builder	parent(Channel parent)	The parent Channel of this EmbeddedChannel.
EmbeddedChannel.Builder	register(boolean register)	true if this Channel is registered to the EventLoop in the constructor.
EmbeddedChannel.Builder	ticker(Ticker ticker)	Configure a custom ticker for this event loop.

Methods inherited from class java.lang.Object

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

Method Detail

parent

public EmbeddedChannel.Builder parent(Channel parent)

The parent Channel of this EmbeddedChannel.

Parameters:

parent - the parent Channel of this EmbeddedChannel.

Returns:

This builder

channelId

public EmbeddedChannel.Builder channelId(ChannelId channelId)

The ChannelId that will be used to identify this channel.

Parameters:

channelId - the ChannelId that will be used to identify this channel

Returns:

This builder

register

public EmbeddedChannel.Builder register(boolean register)

true if this Channel is registered to the EventLoop in the constructor. If false the user will need to call EmbeddedChannel.register().

Parameters:

register - true if this Channel is registered to the EventLoop in the constructor. If false the user will need to call EmbeddedChannel.register().

Returns:

This builder

hasDisconnect

public EmbeddedChannel.Builder hasDisconnect(boolean hasDisconnect)

false if this Channel will delegate EmbeddedChannel.disconnect() to EmbeddedChannel.close(), true otherwise.

Parameters:

hasDisconnect - false if this Channel will delegate EmbeddedChannel.disconnect() to EmbeddedChannel.close(), true otherwise

Returns:

This builder

handlers

public EmbeddedChannel.Builder handlers(ChannelHandler... handlers)

The ChannelHandlers which will be added to the ChannelPipeline.

Parameters:

handlers - the ChannelHandlers which will be added to the ChannelPipeline

Returns:

This builder

handlers

public EmbeddedChannel.Builder handlers(ChannelHandler handler)

The ChannelHandler which will be added to the ChannelPipeline.

Parameters:

handler - the ChannelHandlers which will be added to the ChannelPipeline

Returns:

This builder

config

public EmbeddedChannel.Builder config(ChannelConfig config)

The ChannelConfig which will be returned by EmbeddedChannel.config().

Parameters:

config - the ChannelConfig which will be returned by EmbeddedChannel.config()

Returns:

This builder

ticker

public EmbeddedChannel.Builder ticker(Ticker ticker)

Configure a custom ticker for this event loop.

Parameters:

ticker - The custom ticker

Returns:

This builder

build

public EmbeddedChannel build()

Create the channel. If you wish to extend EmbeddedChannel, please use the #EmbeddedChannel(Builder) constructor instead.

Returns:

The channel