com.azure.core.http.netty

Class NettyAsyncHttpClientBuilder

java.lang.Object

com.azure.core.http.netty.NettyAsyncHttpClientBuilder

public class NettyAsyncHttpClientBuilder
extends Object

Builder class responsible for creating instances of NettyAsyncHttpClient.

Building a new HttpClient instance

HttpClient client = new NettyAsyncHttpClientBuilder()
    .port(8080)
    .wiretap(true)
    .build();

See Also:

NettyAsyncHttpClient, HttpClient

Constructor Summary

Constructors

Constructor and Description
NettyAsyncHttpClientBuilder() Creates a new builder instance, where a builder is capable of generating multiple instances of NettyAsyncHttpClient.

Method Summary

Modifier and Type	Method and Description
HttpClient	build() Creates a new Netty-backed HttpClient instance on every call, using the configuration set in the builder at the time of the build method call.
NettyAsyncHttpClientBuilder	connectionProvider(reactor.netty.resources.ConnectionProvider connectionProvider) Sets the connection provider.
NettyAsyncHttpClientBuilder	nioEventLoopGroup(NioEventLoopGroup nioEventLoopGroup) Sets the NIO event loop group that will be used to run IO loops.
NettyAsyncHttpClientBuilder	port(int port) Sets the port which this client should connect, which by default will be set to port 80.
NettyAsyncHttpClientBuilder	proxy(ProxyOptions proxyOptions) Sets the proxy options that the client will use.
NettyAsyncHttpClientBuilder	wiretap(boolean enableWiretap) Enables the Netty wiretap feature.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyAsyncHttpClientBuilder

public NettyAsyncHttpClientBuilder()

Creates a new builder instance, where a builder is capable of generating multiple instances of NettyAsyncHttpClient.

Method Detail

build

public HttpClient build()

Creates a new Netty-backed HttpClient instance on every call, using the configuration set in the builder at the time of the build method call.

Returns:

A new Netty-backed HttpClient instance.

Throws:

IllegalStateException - If the builder is configured to use an unknown proxy type.

connectionProvider

public NettyAsyncHttpClientBuilder connectionProvider(reactor.netty.resources.ConnectionProvider connectionProvider)

Sets the connection provider.

Parameters:

connectionProvider - the connection provider

Returns:

the updated NettyAsyncHttpClientBuilder object

proxy

public NettyAsyncHttpClientBuilder proxy(ProxyOptions proxyOptions)

Sets the proxy options that the client will use.

Code Samples

HttpClient client = new NettyAsyncHttpClientBuilder()
    .proxy(new ProxyOptions(ProxyOptions.Type.HTTP, new InetSocketAddress("<proxy-host>", 8888)))
    .build();

Parameters:

proxyOptions - The proxy configuration to use.

Returns:

the updated NettyAsyncHttpClientBuilder object

wiretap

public NettyAsyncHttpClientBuilder wiretap(boolean enableWiretap)

Enables the Netty wiretap feature.

Parameters:

enableWiretap - Flag indicating wiretap status

Returns:

the updated NettyAsyncHttpClientBuilder object

port

public NettyAsyncHttpClientBuilder port(int port)

Sets the port which this client should connect, which by default will be set to port 80.

Parameters:

port - The port to connect to.

Returns:

the updated NettyAsyncHttpClientBuilder object

nioEventLoopGroup

public NettyAsyncHttpClientBuilder nioEventLoopGroup(NioEventLoopGroup nioEventLoopGroup)

Sets the NIO event loop group that will be used to run IO loops.

Code Samples

int threadCount = 5;
HttpClient client = new NettyAsyncHttpClientBuilder()
    .nioEventLoopGroup(new NioEventLoopGroup(threadCount))
    .build();

Parameters:

nioEventLoopGroup - The NioEventLoopGroup that will run IO loops.

Returns:

the updated NettyAsyncHttpClientBuilder object