ktor-network/io.ktor.network.sockets

Package-level declarations

Types

ABoundSocket

interface ABoundSocket

Represents a bound socket

Acceptable

interface Acceptable<out S : ASocket> : ASocket

Represents a socket source, for example server socket

AConnectedSocket

interface AConnectedSocket : AWritable

Represent a connected socket

AReadable

interface AReadable

Represent a readable socket

ASocket

interface ASocket : Closeable, DisposableHandle

Base type for all async sockets

AWritable

interface AWritable

Represents a writable socket

BoundDatagramSocket

interface BoundDatagramSocket : ASocket, ABoundSocket, AReadable, DatagramReadWriteChannel

Represents a bound datagram socket

Configurable

interface Configurable<out T : Configurable<T, Options>, Options : SocketOptions>

Represent a configurable socket

ConnectedDatagramSocket

interface ConnectedDatagramSocket : ASocket, ABoundSocket, AConnectedSocket, ReadWriteSocket, DatagramReadWriteChannel

Represents a connected datagram socket.

Connection

class Connection(val socket: Socket, val input: ByteReadChannel, val output: ByteWriteChannel)

Represents a connected socket with its input and output

Datagram

class Datagram(val packet: ByteReadPacket, val address: SocketAddress)

UDP datagram with packet content targeted to address

DatagramReadChannel

interface DatagramReadChannel

A channel for receiving datagrams

DatagramReadWriteChannel

interface DatagramReadWriteChannel : DatagramReadChannel, DatagramWriteChannel

A channel for sending and receiving datagrams

DatagramWriteChannel

interface DatagramWriteChannel

A channel for sending datagrams

InetSocketAddress

expect class InetSocketAddress(hostname: String, port: Int) : SocketAddress

actual class InetSocketAddress(hostname: String, port: Int) : SocketAddress

actual data class InetSocketAddress(val hostname: String, val port: Int) : SocketAddress

ReadWriteSocket

interface ReadWriteSocket : ASocket, AReadable, AWritable

Represents both readable and writable socket

ServerSocket

interface ServerSocket : ASocket, ABoundSocket, Acceptable<Socket>

Represents a server bound socket ready for accepting connections

Socket

interface Socket : ReadWriteSocket, ABoundSocket, AConnectedSocket

Represents a connected socket

SocketAddress

expect sealed class SocketAddress

actual sealed class SocketAddress

SocketBuilder

class SocketBuilder : Configurable<SocketBuilder, SocketOptions>

Socket builder

SocketOptions

sealed class SocketOptions

Socket options builder

SocketTimeoutException

expect class SocketTimeoutException : IOException

actual typealias SocketTimeoutException = SocketTimeoutException

actual class SocketTimeoutException : IOException

TcpSocketBuilder

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

TCP socket builder

TypeOfService

@JvmInline

value class TypeOfService(val value: UByte)

An inline class to hold a IP ToS value

UDPSocketBuilder

class UDPSocketBuilder(selector: SelectorManager, var options: SocketOptions.UDPSocketOptions) : Configurable<UDPSocketBuilder, SocketOptions.UDPSocketOptions>

UDP socket builder

UnixSocketAddress

expect class UnixSocketAddress(path: String) : SocketAddress

actual class UnixSocketAddress(path: String) : SocketAddress

actual data class UnixSocketAddress(val path: String) : SocketAddress

Functions

aSocket

fun aSocket(selector: SelectorManager): SocketBuilder

Start building a socket

awaitClosed

suspend fun ASocket.awaitClosed()

Await until socket close

connect

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

connection

fun Socket.connection(): Connection

Opens socket input and output channels and returns connection object

openReadChannel

fun AReadable.openReadChannel(): ByteReadChannel

Open a read channel, could be done only once

openWriteChannel

fun AWritable.openWriteChannel(autoFlush: Boolean = false): ByteWriteChannel

Open a write channel, could be opened only once

tcpNoDelay

fun <T : Configurable<T, *>> T.tcpNoDelay(): T

Set TCP_NODELAY socket option to disable the Nagle algorithm.

toJavaAddress

fun SocketAddress.toJavaAddress(): SocketAddress

Properties

isClosed

val ASocket.isClosed: Boolean

Check if the socket is closed