ktor-network/io.ktor.network.sockets/TcpSocketBuilder

TcpSocketBuilder

class TcpSocketBuilder(selector: SelectorManager, options: SocketOptions) : Configurable<TcpSocketBuilder, SocketOptions>

TCP socket builder

Constructors

TcpSocketBuilder

fun TcpSocketBuilder(selector: SelectorManager, options: SocketOptions)

Functions

fun bind(localAddress: NetworkAddress? = null, configure: SocketOptions.AcceptorOptions.() -> Unit = {}): ServerSocket

Bind server socket to listen to localAddress.

fun bind(hostname: String = "0.0.0.0", port: Int = 0, configure: SocketOptions.AcceptorOptions.() -> Unit = {}): ServerSocket

Bind server socket at port to listen to hostname.

open fun configure(block: SocketOptions.() -> Unit): TcpSocketBuilder

Configure socket options in block function

suspend fun connect(remoteAddress: NetworkAddress, configure: SocketOptions.TCPClientSocketOptions.() -> Unit = {}): Socket

Connect to remoteAddress.

suspend fun connect(hostname: String, port: Int, configure: SocketOptions.TCPClientSocketOptions.() -> Unit = {}): Socket

Connect to hostname and port.

Properties

open override var options: SocketOptions

Current socket options

Extensions

suspend fun TcpSocketBuilder.connect(remoteAddress: SocketAddress, configure: SocketOptions.TCPClientSocketOptions.() -> Unit = {}): Socket