ktor-network/io.ktor.network.sockets/SocketOptions/TCPClientSocketOptions

TCPClientSocketOptions

class TCPClientSocketOptions : SocketOptions.PeerSocketOptions

Represents TCP client socket options

Properties

keepAlive

var keepAlive: Boolean? = null

SO_KEEPALIVE option is to enable/disable TCP keep-alive

lingerSeconds

var lingerSeconds: Int

SO_LINGER option applied at socket close, not recommended to set to 0 however useful for debugging Value of -1 is the default and means that it is not set and system-dependant

noDelay

var noDelay: Boolean = true

TCP_NODELAY socket option, useful to disable Nagle

receiveBufferSize

var receiveBufferSize: Int

Socket incoming buffer size (SO_RCVBUF), -1 or 0 to make system decide

reuseAddress

var reuseAddress: Boolean = false

SO_REUSEADDR option

reusePort

var reusePort: Boolean = false

SO_REUSEPORT option, may not work with old JDK (will be silently ignored)

sendBufferSize

var sendBufferSize: Int

Socket ougoing buffer size (SO_SNDBUF), -1 or 0 to make system decide

socketTimeout

var socketTimeout: Long

Socket timeout (read and write).

typeOfService

var typeOfService: TypeOfService

ToS value, TypeOfService.UNDEFINED by default, may not work with old JDK (will be silently ignored)