com.microsoft.rest.v2.http

Class NettyClient.Factory

java.lang.Object

com.microsoft.rest.v2.http.NettyClient.Factory

All Implemented Interfaces:

HttpClientFactory, Closeable, AutoCloseable

Enclosing class:

NettyClient

public static class NettyClient.Factory
extends Object
implements HttpClientFactory

The factory for creating a NettyClient.

Constructor Summary

Constructors

Constructor and Description
Factory() Create a Netty client factory with default settings.
Factory(io.netty.bootstrap.Bootstrap baseBootstrap, int eventLoopGroupSize, int channelPoolSize) Create a Netty client factory, specifying the event loop group size and the channel pool size.
Factory(io.netty.bootstrap.Bootstrap baseBootstrap, int eventLoopGroupSize, int channelPoolSize, io.netty.handler.ssl.SslContext sslContext) Create a Netty client factory, specifying the event loop group size and the channel pool size.
Factory(io.netty.bootstrap.Bootstrap baseBootstrap, int eventLoopGroupSize, SharedChannelPoolOptions options, io.netty.handler.ssl.SslContext sslContext) Create a Netty client factory, specifying the event loop group size and the channel pool options.
Factory(SharedChannelPoolOptions options) Create a Netty client factory, specifying the channel pool options.

Method Summary

Modifier and Type	Method and Description
void	close() Awaits completion of in-flight requests, then closes shared resources associated with this HttpClient.Factory.
HttpClient	create(HttpClientConfiguration configuration) Creates an HttpClient with the given Configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Factory

public Factory()

Create a Netty client factory with default settings.

Factory

public Factory(SharedChannelPoolOptions options)

Create a Netty client factory, specifying the channel pool options.

Parameters:

options - the options to configure the channel pool

Factory

public Factory(io.netty.bootstrap.Bootstrap baseBootstrap,
               int eventLoopGroupSize,
               int channelPoolSize)

Create a Netty client factory, specifying the event loop group size and the channel pool size.

Parameters:

baseBootstrap - a channel Bootstrap to use as a basis for channel creation

eventLoopGroupSize - the number of event loop executors

channelPoolSize - the number of pooled channels (connections)

Factory

public Factory(io.netty.bootstrap.Bootstrap baseBootstrap,
               int eventLoopGroupSize,
               int channelPoolSize,
               io.netty.handler.ssl.SslContext sslContext)

Create a Netty client factory, specifying the event loop group size and the channel pool size.

Parameters:

baseBootstrap - a channel Bootstrap to use as a basis for channel creation

eventLoopGroupSize - the number of event loop executors

channelPoolSize - the number of pooled channels (connections)

sslContext - An SslContext, can be null.

Factory

public Factory(io.netty.bootstrap.Bootstrap baseBootstrap,
               int eventLoopGroupSize,
               SharedChannelPoolOptions options,
               io.netty.handler.ssl.SslContext sslContext)

Create a Netty client factory, specifying the event loop group size and the channel pool options.

Parameters:

baseBootstrap - a channel Bootstrap to use as a basis for channel creation

eventLoopGroupSize - the number of event loop executors

options - the options to configure the channel pool

sslContext - An SslContext, can be null.

Method Detail

create

public HttpClient create(HttpClientConfiguration configuration)

Description copied from interface: HttpClientFactory

Creates an HttpClient with the given Configuration.

Specified by:

create in interface HttpClientFactory

Parameters:

configuration - the configuration.

Returns:

the HttpClient.

close

public void close()

Description copied from interface: HttpClientFactory

Awaits completion of in-flight requests, then closes shared resources associated with this HttpClient.Factory. After this method returns, HttpClients created from this Factory can no longer be used.

Specified by:

close in interface HttpClientFactory

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable