NetClientOptions

Options for configuring a {@link hunt.net.NetClient}.

@author <a href="http://tfox.org">Tim Fox</a>

class NetClientOptions : ClientOptionsBase {}

Constructors

this
this()

The default constructor

this
this(NetClientOptions other)

Copy constructor

Members

Functions

getHostnameVerificationAlgorithm
string getHostnameVerificationAlgorithm()

@return the value of the hostname verification algorithm

getReconnectAttempts
int getReconnectAttempts()

@return the value of reconnect attempts

getReconnectInterval
Duration getReconnectInterval()

@return the value of reconnect interval

opEquals
bool opEquals(Object o)
Undocumented in source. Be warned that the author may not have intended to support it.
setConnectTimeout
NetClientOptions setConnectTimeout(Duration connectTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setHostnameVerificationAlgorithm
NetClientOptions setHostnameVerificationAlgorithm(string hostnameVerificationAlgorithm)

Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty string

setIdleTimeout
NetClientOptions setIdleTimeout(Duration idleTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setLocalAddress
NetClientOptions setLocalAddress(string localAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setLogActivity
NetClientOptions setLogActivity(bool logEnabled)

@return the value of reconnect interval

setMetricsName
NetClientOptions setMetricsName(string metricsName)
Undocumented in source. Be warned that the author may not have intended to support it.
setOpenSslEngineOptions
ClientOptionsBase setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setProxyOptions
NetClientOptions setProxyOptions(ProxyOptions proxyOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setReceiveBufferSize
NetClientOptions setReceiveBufferSize(int receiveBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setReconnectAttempts
NetClientOptions setReconnectAttempts(int attempts)

Set the value of reconnect attempts

setReconnectInterval
NetClientOptions setReconnectInterval(Duration interval)

Set the reconnect interval

setReuseAddress
NetClientOptions setReuseAddress(bool reuseAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setReusePort
NetClientOptions setReusePort(bool reusePort)
Undocumented in source. Be warned that the author may not have intended to support it.
setSendBufferSize
NetClientOptions setSendBufferSize(int sendBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setSoLinger
NetClientOptions setSoLinger(int soLinger)
Undocumented in source. Be warned that the author may not have intended to support it.
setSsl
NetClientOptions setSsl(bool ssl)
Undocumented in source. Be warned that the author may not have intended to support it.
setSslHandshakeTimeout
NetClientOptions setSslHandshakeTimeout(Duration sslHandshakeTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpCork
NetClientOptions setTcpCork(bool tcpCork)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpFastOpen
NetClientOptions setTcpFastOpen(bool tcpFastOpen)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpKeepAlive
NetClientOptions setTcpKeepAlive(bool tcpKeepAlive)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpNoDelay
NetClientOptions setTcpNoDelay(bool tcpNoDelay)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpQuickAck
NetClientOptions setTcpQuickAck(bool tcpQuickAck)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrafficClass
NetClientOptions setTrafficClass(int trafficClass)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrustAll
NetClientOptions setTrustAll(bool trustAll)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseAlpn
NetClientOptions setUseAlpn(bool useAlpn)
Undocumented in source. Be warned that the author may not have intended to support it.
toHash
size_t toHash()
Undocumented in source. Be warned that the author may not have intended to support it.
toStreamOptions
TcpStreamOptions toStreamOptions()
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM
enum string DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM;

Default value to determine hostname verification algorithm hostname verification (for SSL/TLS) = ""

DEFAULT_RECONNECT_ATTEMPTS
enum int DEFAULT_RECONNECT_ATTEMPTS;

The default value for reconnect attempts = 0

DEFAULT_RECONNECT_INTERVAL
enum Duration DEFAULT_RECONNECT_INTERVAL;

The default value for reconnect interval = 1000 ms

Inherited Members

From ClientOptionsBase

DEFAULT_CONNECT_TIMEOUT
enum int DEFAULT_CONNECT_TIMEOUT;

The default value of connect timeout = 60000 ms

DEFAULT_TRUST_ALL
enum bool DEFAULT_TRUST_ALL;

The default value of whether all servers (SSL/TLS) should be trusted = false

DEFAULT_METRICS_NAME
enum string DEFAULT_METRICS_NAME;

The default value of the client metrics = "":

isTrustAll
bool isTrustAll()

@return true if all server certificates should be trusted

setTrustAll
ClientOptionsBase setTrustAll(bool trustAll)

Set whether all server certificates should be trusted

getConnectTimeout
Duration getConnectTimeout()

@return the value of connect timeout

setConnectTimeout
ClientOptionsBase setConnectTimeout(Duration connectTimeout)

Set the connect timeout

getMetricsName
string getMetricsName()

@return the metrics name identifying the reported metrics.

setMetricsName
ClientOptionsBase setMetricsName(string metricsName)

Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

setProxyOptions
ClientOptionsBase setProxyOptions(ProxyOptions proxyOptions)

Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

getProxyOptions
ProxyOptions getProxyOptions()

Get proxy options for connections

getLocalAddress
string getLocalAddress()

@return the local interface to bind for network connections.

setLocalAddress
ClientOptionsBase setLocalAddress(string localAddress)

Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

setLogActivity
ClientOptionsBase setLogActivity(bool logEnabled)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpNoDelay
ClientOptionsBase setTcpNoDelay(bool tcpNoDelay)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpKeepAlive
ClientOptionsBase setTcpKeepAlive(bool tcpKeepAlive)
Undocumented in source. Be warned that the author may not have intended to support it.
setSoLinger
ClientOptionsBase setSoLinger(int soLinger)
Undocumented in source. Be warned that the author may not have intended to support it.
setIdleTimeout
ClientOptionsBase setIdleTimeout(Duration idleTimeout)
Undocumented in source. Be warned that the author may not have intended to support it.
setSsl
ClientOptionsBase setSsl(bool ssl)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseAlpn
ClientOptionsBase setUseAlpn(bool useAlpn)
Undocumented in source. Be warned that the author may not have intended to support it.
setOpenSslEngineOptions
ClientOptionsBase setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
Undocumented in source. Be warned that the author may not have intended to support it.
setSendBufferSize
ClientOptionsBase setSendBufferSize(int sendBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setReceiveBufferSize
ClientOptionsBase setReceiveBufferSize(int receiveBufferSize)
Undocumented in source. Be warned that the author may not have intended to support it.
setReuseAddress
ClientOptionsBase setReuseAddress(bool reuseAddress)
Undocumented in source. Be warned that the author may not have intended to support it.
setReusePort
ClientOptionsBase setReusePort(bool reusePort)
Undocumented in source. Be warned that the author may not have intended to support it.
setTrafficClass
ClientOptionsBase setTrafficClass(int trafficClass)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpFastOpen
ClientOptionsBase setTcpFastOpen(bool tcpFastOpen)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpCork
ClientOptionsBase setTcpCork(bool tcpCork)
Undocumented in source. Be warned that the author may not have intended to support it.
setTcpQuickAck
ClientOptionsBase setTcpQuickAck(bool tcpQuickAck)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object o)
Undocumented in source. Be warned that the author may not have intended to support it.
toHash
size_t toHash()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta