io.ktor.network.sockets / SocketOptions / TCPClientSocketOptions

TCPClientSocketOptions

class TCPClientSocketOptions : PeerSocketOptions

Represents TCP client socket options

Properties

keepAlive
var keepAlive: Boolean?

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

TCP_NODELAY socket option, useful to disable Nagle

socketTimeout
var socketTimeout: Long

Socket timeout (read and write).

Inherited Properties

receiveBufferSize
var receiveBufferSize: Int

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

sendBufferSize
var sendBufferSize: Int

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

Functions

copyCommon
fun copyCommon(from: SocketOptions): Unit