io.netty.handler.codec.http2

Class Http2StreamChannelBootstrap

java.lang.Object

io.netty.handler.codec.http2.Http2StreamChannelBootstrap

@UnstableApi
public class Http2StreamChannelBootstrap
extends Object

A class that makes it easy to bootstrap a new HTTP/2 stream as a Channel.

The bootstrap requires a registered parent Channel with a ChannelPipeline that contains the Http2MultiplexCodec.

A child channel becomes active as soon as it is registered to an eventloop. Therefore, an active channel does not map to an active HTTP/2 stream immediately. Only once a Http2HeadersFrame has been sent or received, does the channel map to an active HTTP/2 stream. In case it was not possible to open a new HTTP/2 stream (i.e. due to the maximum number of active streams being exceeded), the child channel receives an exception indicating the reason and is closed immediately thereafter.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
Http2StreamChannelBootstrap()

Method Summary

Modifier and Type	Method and Description
<T> Http2StreamChannelBootstrap	attr(AttributeKey<T> key, T value) Specify attributes with an initial value to be set on newly created channels.
Map<AttributeKey<?>,Object>	attributes()
ChannelFuture	connect() Creates a new channel that will eventually map to a local/outbound HTTP/2 stream.
EventLoopGroup	group()
Http2StreamChannelBootstrap	group(EventLoopGroup group) Sets the EventLoop to which channels created with this bootstrap are registered.
ChannelHandler	handler()
Http2StreamChannelBootstrap	handler(ChannelHandler handler) Sets the channel handler that should be added to the channels's pipeline.
<T> Http2StreamChannelBootstrap	option(ChannelOption<T> option, T value) Specify ChannelOptions to be set on newly created channels.
Map<ChannelOption<?>,Object>	options()
Channel	parentChannel()
Http2StreamChannelBootstrap	parentChannel(Channel parent) Sets the parent channel that must have the Http2MultiplexCodec in its pipeline.

Methods inherited from class java.lang.Object

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

Constructor Detail

Http2StreamChannelBootstrap

public Http2StreamChannelBootstrap()

Method Detail

connect

public ChannelFuture connect()

Creates a new channel that will eventually map to a local/outbound HTTP/2 stream.

parentChannel

public Http2StreamChannelBootstrap parentChannel(Channel parent)

Sets the parent channel that must have the Http2MultiplexCodec in its pipeline.

Parameters:

parent - a registered channel with the Http2MultiplexCodec in its pipeline. This channel will be the Channel.parent() of all channels created via connect().

Returns:

this

handler

public Http2StreamChannelBootstrap handler(ChannelHandler handler)

Sets the channel handler that should be added to the channels's pipeline.

Parameters:

handler - the channel handler to add to the channel's pipeline. The handler must be ChannelHandler.Sharable.

Returns:

this

group

public Http2StreamChannelBootstrap group(EventLoopGroup group)

Sets the EventLoop to which channels created with this bootstrap are registered.

Parameters:

group - the eventloop or null if the eventloop of the parent channel should be used.

Returns:

this

option

public <T> Http2StreamChannelBootstrap option(ChannelOption<T> option,
                                              T value)

Specify ChannelOptions to be set on newly created channels. An option can be removed by specifying a value of null.

attr

public <T> Http2StreamChannelBootstrap attr(AttributeKey<T> key,
                                            T value)

Specify attributes with an initial value to be set on newly created channels. An attribute can be removed by specifying a value of null.

parentChannel

public Channel parentChannel()

handler

public ChannelHandler handler()

group

public EventLoopGroup group()

options

public Map<ChannelOption<?>,Object> options()

attributes

public Map<AttributeKey<?>,Object> attributes()