Package org.apache.pulsar.client.api.v5.config

Class ConnectionPolicy

java.lang.Object

org.apache.pulsar.client.api.v5.config.ConnectionPolicy

public final class ConnectionPolicy
extends Object

Connection-level settings for the Pulsar client.

Groups TCP connection timeout, connection pool sizing, keep-alive, idle timeout, TCP no-delay, I/O and callback threading, and proxy configuration.

Construct via builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConnectionPolicy.Builder	Builder for ConnectionPolicy.

Method Summary

Modifier and Type	Method	Description
static ConnectionPolicy.Builder	builder()
int	callbackThreads()
BackoffPolicy	connectionBackoff()
Duration	connectionMaxIdleTime()
int	connectionsPerBroker()
Duration	connectionTimeout()
boolean	enableTcpNoDelay()
int	ioThreads()
Duration	keepAliveInterval()
ProxyProtocol	proxyProtocol()
String	proxyServiceUrl()

Methods inherited from class java.lang.Object

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

Method Details

connectionTimeout

public Duration connectionTimeout()

Returns:

the maximum duration to wait for a TCP connection to a broker

connectionsPerBroker

public int connectionsPerBroker()

Returns:

the number of TCP connections maintained per broker

enableTcpNoDelay

public boolean enableTcpNoDelay()

Returns:

whether TCP no-delay (Nagle disabled) is enabled

keepAliveInterval

public Duration keepAliveInterval()

Returns:

the interval between TCP keep-alive probes

connectionMaxIdleTime

public Duration connectionMaxIdleTime()

Returns:

the maximum idle duration before a connection is closed

ioThreads

public int ioThreads()

Returns:

the number of I/O threads

callbackThreads

public int callbackThreads()

Returns:

the number of callback threads

proxyServiceUrl

public String proxyServiceUrl()

Returns:

the proxy service URL, or null if no proxy is configured

proxyProtocol

public ProxyProtocol proxyProtocol()

Returns:

the proxy protocol, or null if no proxy is configured

connectionBackoff

public BackoffPolicy connectionBackoff()

Returns:

the broker-reconnection backoff policy

builder

public static ConnectionPolicy.Builder builder()

Returns:

a new builder for constructing a ConnectionPolicy