ktor-network

alltypes

interface ABoundSocket

abstract val localAddress: <ERROR CLASS>

interface AConnectedSocket : AWritable

abstract val remoteAddress: <ERROR CLASS>

interface AReadable

abstract fun attachForReading(channel: ByteChannel): WriterJob

interface ASocket : DisposableHandle

open fun dispose(): Unit
abstract val socketContext: Job

interface AWritable

abstract fun attachForWriting(channel: ByteChannel): ReaderJob

interface Acceptable<out S : ASocket> : ASocket

abstract suspend fun accept(): S

class ActorSelectorManager : SelectorManagerSupport, Closeable, CoroutineScope

ActorSelectorManager(context: <ERROR CLASS>)
fun close(): Unit
val coroutineContext: <ERROR CLASS>
fun notifyClosed(s: Selectable): Unit
protected fun publishInterest(selectable: Selectable): Unit

interface BoundDatagramSocket : ASocket, ABoundSocket, AReadable, DatagramReadWriteChannel
class ClosedChannelCancellationException

ClosedChannelCancellationException()

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

open fun configure(block: Options.() -> Unit): T
abstract var options: Options

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

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

class Datagram

Datagram(packet: ByteReadPacket, address: <ERROR CLASS>)
val address: <ERROR CLASS>
val packet: ByteReadPacket

interface DatagramReadChannel

abstract val incoming: ReceiveChannel<Datagram>
open suspend fun receive(): Datagram

interface DatagramReadWriteChannel : DatagramReadChannel, DatagramWriteChannel
interface DatagramWriteChannel

abstract val outgoing: SendChannel<Datagram>
open suspend fun send(datagram: Datagram): Unit

class IOCoroutineDispatcher : CoroutineDispatcher

IOCoroutineDispatcher(nThreads: Int)
fun close(): Unit
fun dispatch(context: <ERROR CLASS>, block: Runnable): Unit

class InterestSuspensionsMap

InterestSuspensionsMap()
fun addSuspension(interest: SelectInterest, continuation: CancellableContinuation<Unit>): Unit
inline fun invokeForEachPresent(readyOps: Int, block: CancellableContinuation<Unit>.() -> Unit): Unit
inline fun invokeForEachPresent(block: CancellableContinuation<Unit>.(SelectInterest) -> Unit): Unit
fun removeSuspension(interest: SelectInterest): CancellableContinuation<Unit>?
fun removeSuspension(interestOrdinal: Int): CancellableContinuation<Unit>?
fun toString(): String

interface ReadWriteSocket : ASocket, AReadable, AWritable
enum expect class SelectInterest

ACCEPT
val AllInterests: Array<SelectInterest>
CONNECT
READ
WRITE
val flag: Int
val flags: IntArray
val size: Int

expect interface Selectable

abstract val channel: SelectableChannel
abstract fun interestOp(interest: SelectInterest, state: Boolean): Unit
abstract val interestedOps: Int
abstract val suspensions: InterestSuspensionsMap

expect interface SelectorManager : CoroutineScope

abstract fun notifyClosed(s: Selectable): Unit
abstract val provider: SelectorProvider
abstract suspend fun select(selectable: Selectable, interest: SelectInterest): Unit

abstract class SelectorManagerSupport : SelectorManager

class ClosedSelectorCancellationException

ClosedSelectorCancellationException()

protected fun applyInterest(selector: Selector, s: Selectable): Unit
protected fun cancelAllSuspensions(attachment: Selectable, t: Throwable): Unit
protected fun cancelAllSuspensions(selector: Selector, t: Throwable?): Unit
protected var cancelled: Int
protected fun handleSelectedKey(key: SelectionKey): Unit
protected fun handleSelectedKeys(selectedKeys: MutableSet<SelectionKey>, keys: Set<SelectionKey>): Unit
protected fun notifyClosedImpl(selector: Selector, key: SelectionKey, attachment: Selectable): Unit
protected var pending: Int
val provider: SelectorProvider
protected abstract fun publishInterest(selectable: Selectable): Unit
suspend fun select(selectable: Selectable, interest: SelectInterest): Unit

interface ServerSocket : ASocket, ABoundSocket, Acceptable<Socket>
interface Socket : ReadWriteSocket, ABoundSocket, AConnectedSocket
class SocketBuilder : Configurable<SocketBuilder, SocketOptions>

var options: SocketOptions
fun tcp(): TcpSocketBuilder
fun udp(): UDPSocketBuilder

sealed class SocketOptions

class AcceptorOptions : SocketOptions
open class PeerSocketOptions : SocketOptions

protected open fun copyCommon(from: SocketOptions): Unit
var receiveBufferSize: Int
var sendBufferSize: Int

class TCPClientSocketOptions : PeerSocketOptions

protected fun copyCommon(from: SocketOptions): Unit
var keepAlive: Boolean?
var lingerSeconds: Int
var noDelay: Boolean
var socketTimeout: Long

class UDPSocketOptions : PeerSocketOptions
protected open fun copyCommon(from: SocketOptions): Unit
protected val customOptions: MutableMap<Any, Any?>
var reuseAddress: Boolean
var reusePort: Boolean
var typeOfService: TypeOfService

class TcpSocketBuilder : Configurable<TcpSocketBuilder, SocketOptions>

TcpSocketBuilder(selector: SelectorManager, options: SocketOptions)
fun bind(hostname: String = "0.0.0.0", port: Int = 0, configure: AcceptorOptions.() -> Unit = {}): ServerSocket
fun bind(localAddress: <ERROR CLASS>? = null, configure: AcceptorOptions.() -> Unit = {}): ServerSocket
suspend fun connect(hostname: String, port: Int, configure: TCPClientSocketOptions.() -> Unit = {}): Socket
suspend fun connect(remoteAddress: <ERROR CLASS>, configure: TCPClientSocketOptions.() -> Unit = {}): Socket
var options: SocketOptions

inline class TypeOfService

TypeOfService(value: Int)
TypeOfService(value: <ERROR CLASS>)
val IPTOS_LOWCOST: TypeOfService
val IPTOS_LOWDELAY: TypeOfService
val IPTOS_RELIABILITY: TypeOfService
val IPTOS_THROUGHPUT: TypeOfService
val UNDEFINED: TypeOfService
inline val intValue: Int
val value: <ERROR CLASS>

class UDPSocketBuilder : Configurable<UDPSocketBuilder, UDPSocketOptions>

UDPSocketBuilder(selector: SelectorManager, options: UDPSocketOptions)
fun bind(localAddress: <ERROR CLASS>? = null, configure: UDPSocketOptions.() -> Unit = {}): BoundDatagramSocket
fun connect(remoteAddress: <ERROR CLASS>, localAddress: <ERROR CLASS>? = null, configure: UDPSocketOptions.() -> Unit = {}): ConnectedDatagramSocket
var options: UDPSocketOptions

package io.ktor.network.selector

class ActorSelectorManager : SelectorManagerSupport, Closeable, CoroutineScope

ActorSelectorManager(context: <ERROR CLASS>)
fun close(): Unit
val coroutineContext: <ERROR CLASS>
fun notifyClosed(s: Selectable): Unit
protected fun publishInterest(selectable: Selectable): Unit

class ClosedChannelCancellationException

ClosedChannelCancellationException()

class InterestSuspensionsMap

InterestSuspensionsMap()
fun addSuspension(interest: SelectInterest, continuation: CancellableContinuation<Unit>): Unit
inline fun invokeForEachPresent(readyOps: Int, block: CancellableContinuation<Unit>.() -> Unit): Unit
inline fun invokeForEachPresent(block: CancellableContinuation<Unit>.(SelectInterest) -> Unit): Unit
fun removeSuspension(interest: SelectInterest): CancellableContinuation<Unit>?
fun removeSuspension(interestOrdinal: Int): CancellableContinuation<Unit>?
fun toString(): String

enum expect class SelectInterest

ACCEPT
val AllInterests: Array<SelectInterest>
CONNECT
READ
WRITE
val flag: Int
val flags: IntArray
val size: Int

expect interface Selectable

abstract val channel: SelectableChannel
abstract fun interestOp(interest: SelectInterest, state: Boolean): Unit
abstract val interestedOps: Int
abstract val suspensions: InterestSuspensionsMap

expect fun SelectorManager(dispatcher: <ERROR CLASS> = EmptyCoroutineContext): SelectorManager
expect interface SelectorManager : CoroutineScope

abstract fun notifyClosed(s: Selectable): Unit
abstract val provider: SelectorProvider
abstract suspend fun select(selectable: Selectable, interest: SelectInterest): Unit

abstract class SelectorManagerSupport : SelectorManager

class ClosedSelectorCancellationException

ClosedSelectorCancellationException()

protected fun applyInterest(selector: Selector, s: Selectable): Unit
protected fun cancelAllSuspensions(attachment: Selectable, t: Throwable): Unit
protected fun cancelAllSuspensions(selector: Selector, t: Throwable?): Unit
protected var cancelled: Int
protected fun handleSelectedKey(key: SelectionKey): Unit
protected fun handleSelectedKeys(selectedKeys: MutableSet<SelectionKey>, keys: Set<SelectionKey>): Unit
protected fun notifyClosedImpl(selector: Selector, key: SelectionKey, attachment: Selectable): Unit
protected var pending: Int
val provider: SelectorProvider
protected abstract fun publishInterest(selectable: Selectable): Unit
suspend fun select(selectable: Selectable, interest: SelectInterest): Unit

inline fun <C, R> SelectorManager.buildOrClose(create: SelectorProvider.() -> C, setup: C.() -> R): R

package io.ktor.network.sockets

interface ABoundSocket

abstract val localAddress: <ERROR CLASS>

interface AConnectedSocket : AWritable

abstract val remoteAddress: <ERROR CLASS>

interface AReadable

abstract fun attachForReading(channel: ByteChannel): WriterJob

interface ASocket : DisposableHandle

open fun dispose(): Unit
abstract val socketContext: Job

interface AWritable

abstract fun attachForWriting(channel: ByteChannel): ReaderJob

interface Acceptable<out S : ASocket> : ASocket

abstract suspend fun accept(): S

interface BoundDatagramSocket : ASocket, ABoundSocket, AReadable, DatagramReadWriteChannel
interface Configurable<out T : Configurable<T, Options>, Options : SocketOptions>

open fun configure(block: Options.() -> Unit): T
abstract var options: Options

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

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

class Datagram

Datagram(packet: ByteReadPacket, address: <ERROR CLASS>)
val address: <ERROR CLASS>
val packet: ByteReadPacket

interface DatagramReadChannel

abstract val incoming: ReceiveChannel<Datagram>
open suspend fun receive(): Datagram

interface DatagramReadWriteChannel : DatagramReadChannel, DatagramWriteChannel
interface DatagramWriteChannel

abstract val outgoing: SendChannel<Datagram>
open suspend fun send(datagram: Datagram): Unit

interface ReadWriteSocket : ASocket, AReadable, AWritable
interface ServerSocket : ASocket, ABoundSocket, Acceptable<Socket>
interface Socket : ReadWriteSocket, ABoundSocket, AConnectedSocket
class SocketBuilder : Configurable<SocketBuilder, SocketOptions>

var options: SocketOptions
fun tcp(): TcpSocketBuilder
fun udp(): UDPSocketBuilder

sealed class SocketOptions

class AcceptorOptions : SocketOptions
open class PeerSocketOptions : SocketOptions

protected open fun copyCommon(from: SocketOptions): Unit
var receiveBufferSize: Int
var sendBufferSize: Int

class TCPClientSocketOptions : PeerSocketOptions

protected fun copyCommon(from: SocketOptions): Unit
var keepAlive: Boolean?
var lingerSeconds: Int
var noDelay: Boolean
var socketTimeout: Long

class UDPSocketOptions : PeerSocketOptions
protected open fun copyCommon(from: SocketOptions): Unit
protected val customOptions: MutableMap<Any, Any?>
var reuseAddress: Boolean
var reusePort: Boolean
var typeOfService: TypeOfService

SocketTimeoutException

expect class SocketTimeoutException

SocketTimeoutException(message: String)

actual typealias SocketTimeoutException = SocketTimeoutException

class TcpSocketBuilder : Configurable<TcpSocketBuilder, SocketOptions>

TcpSocketBuilder(selector: SelectorManager, options: SocketOptions)
fun bind(hostname: String = "0.0.0.0", port: Int = 0, configure: AcceptorOptions.() -> Unit = {}): ServerSocket
fun bind(localAddress: <ERROR CLASS>? = null, configure: AcceptorOptions.() -> Unit = {}): ServerSocket
suspend fun connect(hostname: String, port: Int, configure: TCPClientSocketOptions.() -> Unit = {}): Socket
suspend fun connect(remoteAddress: <ERROR CLASS>, configure: TCPClientSocketOptions.() -> Unit = {}): Socket
var options: SocketOptions

inline class TypeOfService

TypeOfService(value: Int)
TypeOfService(value: <ERROR CLASS>)
val IPTOS_LOWCOST: TypeOfService
val IPTOS_LOWDELAY: TypeOfService
val IPTOS_RELIABILITY: TypeOfService
val IPTOS_THROUGHPUT: TypeOfService
val UNDEFINED: TypeOfService
inline val intValue: Int
val value: <ERROR CLASS>

class UDPSocketBuilder : Configurable<UDPSocketBuilder, UDPSocketOptions>

UDPSocketBuilder(selector: SelectorManager, options: UDPSocketOptions)
fun bind(localAddress: <ERROR CLASS>? = null, configure: UDPSocketOptions.() -> Unit = {}): BoundDatagramSocket
fun connect(remoteAddress: <ERROR CLASS>, localAddress: <ERROR CLASS>? = null, configure: UDPSocketOptions.() -> Unit = {}): ConnectedDatagramSocket
var options: UDPSocketOptions

fun aSocket(selector: SelectorManager): SocketBuilder
suspend fun ASocket.awaitClosed(): Unit
suspend fun TcpSocketBuilder.connect(remoteAddress: SocketAddress, configure: TCPClientSocketOptions.() -> Unit = {}): Socket
fun Socket.connection(): Connection
val ASocket.isClosed: Boolean
fun AReadable.openReadChannel(): ByteReadChannel
fun AWritable.openWriteChannel(autoFlush: Boolean = false): ByteWriteChannel
fun <T : Configurable<T, *>> T.tcpNoDelay(): T

package io.ktor.network.util

val DefaultByteBufferPool: ObjectPool<ByteBuffer>
val DefaultDatagramByteBufferPool: ObjectPool<ByteBuffer>
class IOCoroutineDispatcher : CoroutineDispatcher

IOCoroutineDispatcher(nThreads: Int)
fun close(): Unit
fun dispatch(context: <ERROR CLASS>, block: Runnable): Unit

val ioCoroutineDispatcher: CoroutineDispatcher
val ioThreadGroup: ThreadGroup