Index

A B C D G H I J L N O P R S T U

A

ABoundSocket - Interface in io.ktor.network.sockets: Represents a bound socket
accept(p) - Method in interface io.ktor.network.sockets.Acceptable: accepts socket connection or suspends if none yet available.
Acceptable<S extends ASocket> - Interface in io.ktor.network.sockets: Represents a socket source, for example server socket
AConnectedSocket - Interface in io.ktor.network.sockets: Represent a connected socket
ActorSelectorManager - Class in io.ktor.network.selector: Default CIO selector manager implementation
ActorSelectorManager(dispatcher) - Constructor for class io.ktor.network.selector.ActorSelectorManager: Default CIO selector manager implementation
addSuspension(interest, continuation) - Method in class io.ktor.network.selector.InterestSuspensionsMap
applyInterest(selector, s) - Method in class io.ktor.network.selector.SelectorManagerSupport: Applies selectable's current interest (should be invoked in selection thread)
AReadable - Interface in io.ktor.network.sockets: Represent a readable socket
ASocket - Interface in io.ktor.network.sockets: Base type for all async sockets
aSocket(selector) - Static method in class io.ktor.network.sockets.BuildersKt: Start building a socket
ASocket.DefaultImpls - Class in io.ktor.network.sockets: Base type for all async sockets
attachForReading(channel) - Method in interface io.ktor.network.sockets.AReadable: Attach channel for reading so incoming bytes appears in the attached channel. Only one channel could be attached
attachForWriting(channel) - Method in interface io.ktor.network.sockets.AWritable: Attach channel for writing so bytes written to the attached channel will be transmitted Only one channel could be attached
awaitClosed($receiver, p) - Static method in class io.ktor.network.sockets.SocketsKt: Await until socket close
AWritable - Interface in io.ktor.network.sockets: Represents a writable socket

B

bind(hostname, port, configure) - Method in class io.ktor.network.sockets.TcpSocketBuilder: Bind server socket at port to listen to hostname
bind(localAddress, configure) - Method in class io.ktor.network.sockets.TcpSocketBuilder: Bind server socket to listen to localAddress
bind(localAddress, configure) - Method in class io.ktor.network.sockets.UDPSocketBuilder: Bind server socket to listen to localAddress
BoundDatagramSocket - Interface in io.ktor.network.sockets: Represents a bound datagram socket
BuildersKt - Class in io.ktor.network.sockets
buildOrClose($receiver, create, setup) - Static method in class io.ktor.network.selector.SelectorManagerKt: Creates a NIO entity via create and calls setup on it. If any exception happens then the entity will be closed and an exception will be propagated.

C

cancelAllSuspensions(attachment, t) - Method in class io.ktor.network.selector.SelectorManagerSupport: Cancel all selectable's suspensions with the specified exception
cancelAllSuspensions(selector, t) - Method in class io.ktor.network.selector.SelectorManagerSupport: Cancel all suspensions with the specified exception, reset all interests
CIOReaderKt - Class in io.ktor.network.sockets
CIOWriterKt - Class in io.ktor.network.sockets
close() - Method in class io.ktor.network.selector.ActorSelectorManager: Close selector manager and release all resources
close() - Method in class io.ktor.network.util.IOCoroutineDispatcher: Deprecated.

Gracefully shutdown dispatcher.
ClosedSelectorCancellationException() - Constructor for exception io.ktor.network.selector.SelectorManagerSupport.ClosedSelectorCancellationException
Companion - Static variable in class io.ktor.network.selector.InterestSuspensionsMap
Companion - Static variable in enum io.ktor.network.selector.SelectInterest
Companion - Static variable in interface io.ktor.network.selector.SelectorManager
Companion - Static variable in class io.ktor.network.sockets.SocketOptions
Companion - Static variable in class io.ktor.network.sockets.TypeOfService
Configurable<T extends Configurable<? extends T,O>,O extends SocketOptions> - Interface in io.ktor.network.sockets: Represent a configurable socket
Configurable.DefaultImpls - Class in io.ktor.network.sockets: Represent a configurable socket
configure(block) - Method in interface io.ktor.network.sockets.Configurable: Configure socket options in block function
configure($this, block) - Static method in class io.ktor.network.sockets.Configurable.DefaultImpls: Configure socket options in block function
connect(hostname, port, configure, p) - Method in class io.ktor.network.sockets.TcpSocketBuilder: Connect to hostname and port
connect(remoteAddress, configure, p) - Method in class io.ktor.network.sockets.TcpSocketBuilder: Connect to remoteAddress
connect(remoteAddress, localAddress, configure) - Method in class io.ktor.network.sockets.UDPSocketBuilder: Create a datagram socket to listen datagrams at localAddress and set to remoteAddress
ConnectedDatagramSocket - Interface in io.ktor.network.sockets: Represents a connected datagram socket.
copy$module() - Method in class io.ktor.network.sockets.SocketOptions.AcceptorOptions: Copy options
copy$module() - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions: Copy options
copy$module() - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: Copy options
copy$module() - Method in class io.ktor.network.sockets.SocketOptions.UDPSocketOptions: Copy options
copyCommon(from) - Method in class io.ktor.network.sockets.SocketOptions
copyCommon(from) - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions
copyCommon(from) - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions

D

Datagram - Class in io.ktor.network.sockets: UDP datagram with packet content targeted to address
Datagram(packet, address) - Constructor for class io.ktor.network.sockets.Datagram: UDP datagram with packet content targeted to address
DatagramKt - Class in io.ktor.network.sockets
DatagramReadChannel - Interface in io.ktor.network.sockets: A channel for receiving datagrams
DatagramReadChannel.DefaultImpls - Class in io.ktor.network.sockets: A channel for receiving datagrams
DatagramReadWriteChannel - Interface in io.ktor.network.sockets: A channel for sending and receiving datagrams
DatagramWriteChannel - Interface in io.ktor.network.sockets: A channel for sending datagrams
DatagramWriteChannel.DefaultImpls - Class in io.ktor.network.sockets: A channel for sending datagrams
dispatch(context, block) - Method in class io.ktor.network.util.IOCoroutineDispatcher: Deprecated.
dispose($this) - Static method in class io.ktor.network.sockets.ASocket.DefaultImpls
dispose() - Method in interface io.ktor.network.sockets.ASocket

G

getAddress() - Method in class io.ktor.network.sockets.Datagram: to send to
getAllInterests() - Method in class io.ktor.network.selector.SelectInterest.Companion
getCancelled() - Method in class io.ktor.network.selector.SelectorManagerSupport: Number of cancelled keys
getChannel() - Method in interface io.ktor.network.selector.Selectable: associated channel
getCoroutineContext() - Method in class io.ktor.network.selector.ActorSelectorManager
getCustomOptions() - Method in class io.ktor.network.sockets.SocketOptions
getDefaultDatagramByteBufferPool() - Static method in class io.ktor.network.util.PoolsKt: Byte buffer pool for UDP datagrams
getEmpty() - Method in class io.ktor.network.sockets.SocketOptions.Companion: Deprecated.
getFlag() - Method in enum io.ktor.network.selector.SelectInterest: to be set in NIO selector
getFlags() - Method in class io.ktor.network.selector.SelectInterest.Companion: interest's flags in enum entry order
getIncoming() - Method in interface io.ktor.network.sockets.DatagramReadChannel: Incoming datagrams channel
getInterestedOps() - Method in interface io.ktor.network.selector.Selectable: current interests
getIntValue() - Method in class io.ktor.network.sockets.TypeOfService: Integer representation of this ToS
getIoCoroutineDispatcher() - Static method in class io.ktor.network.util.PoolsKt: Deprecated.
getIoThreadGroup() - Static method in class io.ktor.network.util.PoolsKt: Deprecated.
getIPTOS_LOWCOST() - Method in class io.ktor.network.sockets.TypeOfService.Companion
getIPTOS_LOWDELAY() - Method in class io.ktor.network.sockets.TypeOfService.Companion
getIPTOS_RELIABILITY() - Method in class io.ktor.network.sockets.TypeOfService.Companion
getIPTOS_THROUGHPUT() - Method in class io.ktor.network.sockets.TypeOfService.Companion
getKeepAlive() - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: SO_KEEPALIVE option is to enable/disable TCP keep-alive
getLingerSeconds() - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: 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
getLocalAddress() - Method in interface io.ktor.network.sockets.ABoundSocket: Local socket address. Could throw an exception if no address bound yet.
getNoDelay() - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: TCP_NODELAY socket option, useful to disable Nagle
getOptions() - Method in interface io.ktor.network.sockets.Configurable: Current socket options
getOptions() - Method in class io.ktor.network.sockets.SocketBuilder: Current socket options
getOptions() - Method in class io.ktor.network.sockets.TcpSocketBuilder: Current socket options
getOptions() - Method in class io.ktor.network.sockets.UDPSocketBuilder: Current socket options
getOutgoing() - Method in interface io.ktor.network.sockets.DatagramWriteChannel: Datagram outgoing channel
getPacket() - Method in class io.ktor.network.sockets.Datagram: content
getPending() - Method in class io.ktor.network.selector.SelectorManagerSupport: Number of pending selectables
getProvider() - Method in interface io.ktor.network.selector.SelectorManager: NIO selector provider
getProvider() - Method in class io.ktor.network.selector.SelectorManagerSupport: NIO selector provider
getReceiveBufferSize() - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions: Socket incoming buffer size (SO_RCVBUF), -1 or 0 to make system decide
getRemoteAddress() - Method in interface io.ktor.network.sockets.AConnectedSocket: Remote socket address. Could throw an exception if the peer is not yet connected or already disconnected.
getReuseAddress() - Method in class io.ktor.network.sockets.SocketOptions: SO_REUSEADDR option
getReusePort() - Method in class io.ktor.network.sockets.SocketOptions: SO_REUSEPORT option, may not work with old JDK (will be silently ignored)
getSendBufferSize() - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions: Socket ougoing buffer size (SO_SNDBUF), -1 or 0 to make system decide
getSize() - Method in class io.ktor.network.selector.SelectInterest.Companion
getSocketContext() - Method in interface io.ktor.network.sockets.ASocket: Represents a socket lifetime, completes at socket closure
getSuspensions() - Method in interface io.ktor.network.selector.Selectable: Current selectable suspensions map
getTypeOfService() - Method in class io.ktor.network.sockets.SocketOptions: ToS value, TypeOfService.Companion.getUNDEFINED by default, may not work with old JDK (will be silently ignored)
getUNDEFINED() - Method in class io.ktor.network.sockets.TypeOfService.Companion
getValue() - Method in class io.ktor.network.sockets.TypeOfService: an unsigned byte IP

H

handleSelectedKey(key) - Method in class io.ktor.network.selector.SelectorManagerSupport: Handles particular selected key
handleSelectedKeys(selectedKeys, keys) - Method in class io.ktor.network.selector.SelectorManagerSupport: Handle selected keys clearing selectedKeys set

I

interestOp(interest, state) - Method in interface io.ktor.network.selector.Selectable: Apply state flag of interest to Selectable.getInterestedOps. Notice that is doesn't actually change selection key.
InterestSuspensionsMap - Class in io.ktor.network.selector
InterestSuspensionsMap() - Constructor for class io.ktor.network.selector.InterestSuspensionsMap
InterestSuspensionsMap.Companion - Class in io.ktor.network.selector
invokeForEachPresent(readyOps, block) - Method in class io.ktor.network.selector.InterestSuspensionsMap
invokeForEachPresent(block) - Method in class io.ktor.network.selector.InterestSuspensionsMap
io.ktor.network.selector - package io.ktor.network.selector
io.ktor.network.sockets - package io.ktor.network.sockets
io.ktor.network.util - package io.ktor.network.util
IOCoroutineDispatcher - Class in io.ktor.network.util: Deprecated.
IOCoroutineDispatcher(nThreads) - Constructor for class io.ktor.network.util.IOCoroutineDispatcher: Deprecated.

Default ktor fixed size dispatcher for doing non-blocking I/O operations and selection
isClosed($receiver) - Static method in class io.ktor.network.sockets.SocketsKt: Check if the socket is closed

J

JavaSocketOptionsKt - Class in io.ktor.network.sockets

L

LockFreeMPSCQueueKt - Class in io.ktor.network.selector

N

notifyClosed(s) - Method in class io.ktor.network.selector.ActorSelectorManager: Notifies the selector that selectable has been closed.
notifyClosed(s) - Method in interface io.ktor.network.selector.SelectorManager: Notifies the selector that selectable has been closed.
notifyClosedImpl(selector, key, attachment) - Method in class io.ktor.network.selector.SelectorManagerSupport: Notify selectable's closure

O

openReadChannel($receiver) - Static method in class io.ktor.network.sockets.SocketsKt: Open a read channel, could be done only once
openWriteChannel($receiver, autoFlush) - Static method in class io.ktor.network.sockets.SocketsKt: Open a write channel, could be opened only once

P

PoolsKt - Class in io.ktor.network.util
publishInterest(selectable) - Method in class io.ktor.network.selector.ActorSelectorManager: Publish current selectable interest
publishInterest(selectable) - Method in class io.ktor.network.selector.SelectorManagerSupport: Publish current selectable interest, any thread

R

ReadWriteSocket - Interface in io.ktor.network.sockets: Represents both readable and writable socket
receive($this, p) - Static method in class io.ktor.network.sockets.DatagramReadChannel.DefaultImpls: Receive a datagram
receive(p) - Method in interface io.ktor.network.sockets.DatagramReadChannel: Receive a datagram
removeSuspension(interest) - Method in class io.ktor.network.selector.InterestSuspensionsMap
removeSuspension(interestOrdinal) - Method in class io.ktor.network.selector.InterestSuspensionsMap

S

select(selectable, interest, p) - Method in interface io.ktor.network.selector.SelectorManager: Suspends until interest is selected for selectable May cause manager to allocate and run selector instance if not yet created.
select(selectable, interest, p) - Method in class io.ktor.network.selector.SelectorManagerSupport: Suspends until interest is selected for selectable May cause manager to allocate and run selector instance if not yet created.
Selectable - Interface in io.ktor.network.selector: A selectable entity with selectable NIO Selectable.getChannel, Selectable.getInterestedOps subscriptions
SelectInterest - Enum in io.ktor.network.selector: Select interest kind
SelectInterest(flag) - Constructor for enum io.ktor.network.selector.SelectInterest: Select interest kind
SelectInterest.Companion - Class in io.ktor.network.selector
SelectorManager - Interface in io.ktor.network.selector: Selector manager is a service that manages NIO selectors and selection threads
SelectorManager.Companion - Class in io.ktor.network.selector
SelectorManagerKt - Class in io.ktor.network.selector
SelectorManagerSupport - Class in io.ktor.network.selector: Base class for NIO selector managers
SelectorManagerSupport.ClosedSelectorCancellationException - Exception in io.ktor.network.selector
send($this, datagram, p) - Static method in class io.ktor.network.sockets.DatagramWriteChannel.DefaultImpls: Send datagram
send(datagram, p) - Method in interface io.ktor.network.sockets.DatagramWriteChannel: Send datagram
ServerSocket - Interface in io.ktor.network.sockets: Represents a server bound socket ready for accepting connections
setCancelled(p) - Method in class io.ktor.network.selector.SelectorManagerSupport: Number of cancelled keys
setKeepAlive(p) - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: SO_KEEPALIVE option is to enable/disable TCP keep-alive
setLingerSeconds(p) - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: 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
setNoDelay(p) - Method in class io.ktor.network.sockets.SocketOptions.TCPClientSocketOptions: TCP_NODELAY socket option, useful to disable Nagle
setOptions(p) - Method in interface io.ktor.network.sockets.Configurable: Current socket options
setOptions(p) - Method in class io.ktor.network.sockets.SocketBuilder: Current socket options
setOptions(p) - Method in class io.ktor.network.sockets.TcpSocketBuilder: Current socket options
setOptions(p) - Method in class io.ktor.network.sockets.UDPSocketBuilder: Current socket options
setPending(p) - Method in class io.ktor.network.selector.SelectorManagerSupport: Number of pending selectables
setReceiveBufferSize(p) - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions: Socket incoming buffer size (SO_RCVBUF), -1 or 0 to make system decide
setReuseAddress(p) - Method in class io.ktor.network.sockets.SocketOptions: SO_REUSEADDR option
setReusePort(p) - Method in class io.ktor.network.sockets.SocketOptions: SO_REUSEPORT option, may not work with old JDK (will be silently ignored)
setSendBufferSize(p) - Method in class io.ktor.network.sockets.SocketOptions.PeerSocketOptions: Socket ougoing buffer size (SO_SNDBUF), -1 or 0 to make system decide
setTypeOfService(p) - Method in class io.ktor.network.sockets.SocketOptions: ToS value, TypeOfService.Companion.getUNDEFINED by default, may not work with old JDK (will be silently ignored)
Socket - Interface in io.ktor.network.sockets: Represents a connected socket
SocketBuilder - Class in io.ktor.network.sockets: Socket builder
SocketOptions - Class in io.ktor.network.sockets: Socket options builder
SocketOptions.AcceptorOptions - Class in io.ktor.network.sockets: TCP server socket options
SocketOptions.Companion - Class in io.ktor.network.sockets
SocketOptions.PeerSocketOptions - Class in io.ktor.network.sockets: Represents TCP client or UDP socket options
SocketOptions.TCPClientSocketOptions - Class in io.ktor.network.sockets: Represents TCP client socket options
SocketOptions.UDPSocketOptions - Class in io.ktor.network.sockets: Represents UDP socket options
SocketsKt - Class in io.ktor.network.sockets

T

tcp() - Method in class io.ktor.network.sockets.SocketBuilder: Build TCP socket
tcpNoDelay($receiver) - Static method in class io.ktor.network.sockets.BuildersKt: Set TCP_NODELAY socket option to disable the Nagle algorithm.
TcpSocketBuilder - Class in io.ktor.network.sockets: TCP socket builder
toString() - Method in class io.ktor.network.selector.InterestSuspensionsMap
TypeOfService - Class in io.ktor.network.sockets: An inline class to hold a IP ToS value
TypeOfService(value) - Constructor for class io.ktor.network.sockets.TypeOfService: An inline class to hold a IP ToS value
TypeOfService(value) - Constructor for class io.ktor.network.sockets.TypeOfService: Creates ToS by integer value discarding extra high bits
TypeOfService.Companion - Class in io.ktor.network.sockets

U

udp() - Method in class io.ktor.network.sockets.SocketBuilder: Build UDP socket
UDPSocketBuilder - Class in io.ktor.network.sockets: UDP socket builder
unbox() - Method in class io.ktor.network.sockets.TypeOfService

A B C D G H I J L N O P R S T U