Index

B C D E F G H I L M N P R S T U V W

B

Binary(fin, buffer) - Constructor for class io.ktor.http.cio.websocket.Frame.Binary: Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.
Binary(fin, packet) - Constructor for class io.ktor.http.cio.websocket.Frame.Binary
bodyComplete() - Method in class io.ktor.http.cio.websocket.FrameParser
boundary(boundaryPrefixed, input, p) - Static method in class io.ktor.http.cio.MultipartKt: Skip multipart boundary
build() - Method in class io.ktor.http.cio.RequestResponseBuilder: Build a packet of request/response
byCode(code) - Method in class io.ktor.http.cio.websocket.Codes.Companion: Get enum value by close reason code
bytes(content, offset, length) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append raw bytes
bytes(content) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append raw bytes
byType(fin, frameType, buffer) - Method in class io.ktor.http.cio.websocket.Frame.Companion: Create a particular class Frame instance by frame type

C

cancel() - Method in class io.ktor.http.cio.internals.WeakTimeoutQueue: Cancel all registered timeouts
CharArrayPoolKt - Class in io.ktor.http.cio.internals
CharsJvmKt - Class in io.ktor.http.cio.internals
CharsKt - Class in io.ktor.http.cio.internals
ChunkedTransferEncodingKt - Class in io.ktor.http.cio
CIOHeaders - Class in io.ktor.http.cio: An adapter from CIO low-level headers map to ktor Headers interface
CIOHeaders(headers) - Constructor for class io.ktor.http.cio.CIOHeaders: An adapter from CIO low-level headers map to ktor Headers interface
CIOMultipartDataBase - Class in io.ktor.http.cio: Represents a multipart data object that does parse and convert parts to ktor's PartData
CIOMultipartDataBase(coroutineContext, channel, contentType, contentLength, formFieldLimit, inMemoryFileUploadLimit) - Constructor for class io.ktor.http.cio.CIOMultipartDataBase: Represents a multipart data object that does parse and convert parts to ktor's PartData
close() - Method in class io.ktor.http.cio.HttpMessage: Release all memory resources hold by this message
close(cause, p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Close session with the specified cause or with no reason if null
Close(buffer) - Constructor for class io.ktor.http.cio.websocket.Frame.Close: Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.
Close(reason) - Constructor for class io.ktor.http.cio.websocket.Frame.Close
Close(packet) - Constructor for class io.ktor.http.cio.websocket.Frame.Close
Close() - Constructor for class io.ktor.http.cio.websocket.Frame.Close
close(cause, p) - Method in class io.ktor.http.cio.websocket.RawWebSocket: Close session with the specified cause or with no reason if null
close(cause, p) - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Close session with the specified cause or with no reason if null
close($receiver, reason, p) - Static method in class io.ktor.http.cio.websocket.WebSocketSessionKt: Send a close frame with the specified reason. May suspend if outgoing channel is full or may throw an exception if it is already closed. The specified reason could be ignored if there was already close frame sent (for example in reply to a peer close frame).
close() - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Closes the message queue
CloseReason - Class in io.ktor.http.cio.websocket: Websocket close reason
CloseReason(code, message) - Constructor for class io.ktor.http.cio.websocket.CloseReason: Websocket close reason
CloseReason(code, message) - Constructor for class io.ktor.http.cio.websocket.CloseReason
CloseReason.Codes - Enum in io.ktor.http.cio.websocket: Standard close reason codes
Codes(code) - Constructor for enum io.ktor.http.cio.websocket.CloseReason.Codes: Standard close reason codes
Codes.Companion - Class in io.ktor.http.cio.websocket
Companion - Static variable in class io.ktor.http.cio.ConnectionOptions
Companion - Static variable in enum io.ktor.http.cio.websocket.CloseReason.Codes
Companion - Static variable in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl
Companion - Static variable in class io.ktor.http.cio.websocket.Frame
Companion - Static variable in enum io.ktor.http.cio.websocket.FrameType
component1() - Method in class io.ktor.http.cio.websocket.CloseReason: close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes
component2() - Method in class io.ktor.http.cio.websocket.CloseReason: a close reason message, could be empty
ConnectionOptions - Class in io.ktor.http.cio: Represents a parsed Connection header
ConnectionOptions(close, keepAlive, upgrade, extraOptions) - Constructor for class io.ktor.http.cio.ConnectionOptions: Represents a parsed Connection header
ConnectionOptions() - Constructor for class io.ktor.http.cio.ConnectionOptions: Represents a parsed Connection header
ConnectionOptions.Companion - Class in io.ktor.http.cio
copy(code, message) - Method in class io.ktor.http.cio.websocket.CloseReason: Websocket close reason
copy() - Method in class io.ktor.http.cio.websocket.Frame: Creates a frame copy
copyMultipart(headers, input, out, p) - Static method in class io.ktor.http.cio.MultipartKt: Deprecated.

D

decodeChunked($receiver, input) - Static method in class io.ktor.http.cio.ChunkedTransferEncodingKt: Start a chunked stream decoder coroutine
decodeChunked(input, out, p) - Static method in class io.ktor.http.cio.ChunkedTransferEncodingKt: Chunked stream decoding loop
DefaultWebSocketSession - Interface in io.ktor.http.cio.websocket: Default websocket session with ping-pong and timeout processing and built-in DefaultWebSocketSession.getCloseReason population
DefaultWebSocketSessionImpl - Class in io.ktor.http.cio.websocket: Default web socket session implementation that handles ping-pongs, close sequence and frame fragmentation
DefaultWebSocketSessionImpl(raw, pingInterval, timeoutMillis, pool) - Constructor for class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Default web socket session implementation that handles ping-pongs, close sequence and frame fragmentation
DefaultWebSocketSessionImpl.Companion - Class in io.ktor.http.cio.websocket
DefaultWebSocketSessionImplKt - Class in io.ktor.http.cio.websocket
dumpTo($receiver, indent, out) - Static method in class io.ktor.http.cio.HttpHeadersMapKt: Dump header values to out, useful for debugging

E

emptyLine() - Method in class io.ktor.http.cio.RequestResponseBuilder: Append an empty line (CR + LF in fact)
encodeChunked(output, coroutineContext, p) - Static method in class io.ktor.http.cio.ChunkedTransferEncodingKt: Start chunked stream encoding coroutine
encodeChunked(output, input, p) - Static method in class io.ktor.http.cio.ChunkedTransferEncodingKt: Chunked stream encoding loop
enqueue(f) - Method in class io.ktor.http.cio.websocket.Serializer
entries() - Method in class io.ktor.http.cio.CIOHeaders
Epilogue(body) - Constructor for class io.ktor.http.cio.MultipartEvent.Epilogue: Represents a multipart content epilogue. A multipart stream could have at most one epilogue.
equals(other) - Method in class io.ktor.http.cio.ConnectionOptions
equals(p) - Method in class io.ktor.http.cio.websocket.CloseReason
expectHttpBody(method, contentLength, transferEncoding, connectionOptions, contentType) - Static method in class io.ktor.http.cio.HttpBodyKt
expectHttpBody(request) - Static method in class io.ktor.http.cio.HttpBodyKt
expectHttpUpgrade(method, upgrade, connectionOptions) - Static method in class io.ktor.http.cio.HttpBodyKt
expectHttpUpgrade(request) - Static method in class io.ktor.http.cio.HttpBodyKt
expectMultipart(headers) - Static method in class io.ktor.http.cio.MultipartKt: Check if we have multipart content

F

find(name, fromIndex) - Method in class io.ktor.http.cio.HttpHeadersMap
flush(p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that WebSocketSession.flush doesn't guarantee that frames were actually delivered.
flush(p) - Method in class io.ktor.http.cio.websocket.RawWebSocket: Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that WebSocketSession.flush doesn't guarantee that frames were actually delivered.
flush(p) - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that WebSocketSession.flush doesn't guarantee that frames were actually delivered.
flush(p) - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Ensures all enqueued messages has been written
Frame - Class in io.ktor.http.cio.websocket: A frame received or ready to be sent. It is not reusable and not thread-safe
frame(bb) - Method in class io.ktor.http.cio.websocket.FrameParser
Frame.Binary - Class in io.ktor.http.cio.websocket: Represents an application level binary frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Note that usually there is no need to handle fragments unless you have a RAW web socket session.
Frame.Close - Class in io.ktor.http.cio.websocket: Represents a low-level level close frame. It could be sent to indicate web socket session end. Usually there is no need to send/handle it unless you have a RAW web socket session.
Frame.Companion - Class in io.ktor.http.cio.websocket
Frame.Ping - Class in io.ktor.http.cio.websocket: Represents a low-level ping frame. Could be sent to test connection (peer should reply with class Frame.Pong). Usually there is no need to send/handle it unless you have a RAW web socket session.
Frame.Pong - Class in io.ktor.http.cio.websocket: Represents a low-level pong frame. Should be sent in reply to a class Frame.Ping frame. Usually there is no need to send/handle it unless you have a RAW web socket session.
Frame.Text - Class in io.ktor.http.cio.websocket: Represents an application level text frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.
FrameKt - Class in io.ktor.http.cio.websocket
FrameParser - Class in io.ktor.http.cio.websocket
FrameParser() - Constructor for class io.ktor.http.cio.websocket.FrameParser
FrameParser.State - Enum in io.ktor.http.cio.websocket
FrameTooBigException(frameSize) - Constructor for exception io.ktor.http.cio.websocket.WebSocketReader.FrameTooBigException: Raised when the frame is bigger than allowed in a current websocket session
FrameType - Enum in io.ktor.http.cio.websocket: Frame types enum
FrameType(controlFrame, opcode) - Constructor for enum io.ktor.http.cio.websocket.FrameType: Frame types enum
FrameType.Companion - Class in io.ktor.http.cio.websocket

G

get(name) - Method in class io.ktor.http.cio.CIOHeaders
get(name) - Method in class io.ktor.http.cio.HttpHeadersMap
get(opcode) - Method in class io.ktor.http.cio.websocket.FrameType.Companion: Find enum FrameType instance by numeric opcode
getAll(name) - Method in class io.ktor.http.cio.CIOHeaders
getAll(name) - Method in class io.ktor.http.cio.HttpHeadersMap
getBody() - Method in class io.ktor.http.cio.MultipartEvent.Epilogue: contains epilogue
getBody() - Method in class io.ktor.http.cio.MultipartEvent.MultipartPart: a channel of part content
getBody() - Method in class io.ktor.http.cio.MultipartEvent.Preamble: contains preamble
getBodyReady() - Method in class io.ktor.http.cio.websocket.FrameParser
getBuffer() - Method in class io.ktor.http.cio.websocket.Frame: a frame content or fragment content
getCaseInsensitiveName() - Method in class io.ktor.http.cio.CIOHeaders
getClose() - Method in class io.ktor.http.cio.ConnectionOptions.Companion: An instance for Connection: close
getClose() - Method in class io.ktor.http.cio.ConnectionOptions: true
getCloseReason() - Method in interface io.ktor.http.cio.websocket.DefaultWebSocketSession: A close reason for this session. It could be null if a session is terminated with no close reason (for example due to connection failure).
getCloseReason() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: A close reason for this session. It could be null if a session is terminated with no close reason (for example due to connection failure).
getCode() - Method in enum io.ktor.http.cio.websocket.CloseReason.Codes
getCode() - Method in class io.ktor.http.cio.websocket.CloseReason: close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes
getControlFrame() - Method in enum io.ktor.http.cio.websocket.FrameType: if this is control frame type
getCoroutineContext() - Method in class io.ktor.http.cio.CIOMultipartDataBase
getCoroutineContext() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl
getCoroutineContext() - Method in class io.ktor.http.cio.websocket.RawWebSocket
getCoroutineContext() - Method in class io.ktor.http.cio.websocket.WebSocketReader
getCoroutineContext() - Method in class io.ktor.http.cio.websocket.WebSocketWriter
getDefaultByteBufferPool() - Static method in class io.ktor.http.cio.internals.HttpByteBufferPoolKt
getDispatcher() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Deprecated.
getDispatcher($this) - Static method in class io.ktor.http.cio.websocket.WebSocketSession.DefaultImpls: Deprecated.
getDispatcher() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Deprecated.
getDisposableHandle() - Method in class io.ktor.http.cio.websocket.Frame: could be invoked when the frame is processed
getEnd() - Method in class io.ktor.http.cio.internals.MutableRange: points to the next character after the last one
getExtraOptions() - Method in class io.ktor.http.cio.ConnectionOptions: a list of extra connection header options other than close,
getFin() - Method in class io.ktor.http.cio.websocket.Frame: is it final fragment,
getFin() - Method in class io.ktor.http.cio.websocket.FrameParser
getFrameSize() - Method in exception io.ktor.http.cio.websocket.WebSocketReader.FrameTooBigException: size of received or posted frame that is too big
getFrameType() - Method in class io.ktor.http.cio.websocket.Frame: enum value
getFrameType() - Method in class io.ktor.http.cio.websocket.FrameParser
getHasOutstandingBytes() - Method in class io.ktor.http.cio.websocket.Serializer
getHasRemaining() - Method in class io.ktor.http.cio.websocket.SimpleFrameCollector
getHeaders() - Method in class io.ktor.http.cio.HttpMessage: request/response headers
getHeaders() - Method in class io.ktor.http.cio.MultipartEvent.MultipartPart: deferred that will be completed once will be parsed
getHttpPipelineCoroutine() - Static method in class io.ktor.http.cio.PipelineKt: HTTP pipeline coroutine name
getHttpPipelineWriterCoroutine() - Static method in class io.ktor.http.cio.PipelineKt: HTTP pipeline writer coroutine name
getIncoming() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Incoming frames channel
getIncoming() - Method in class io.ktor.http.cio.websocket.RawWebSocket: Incoming frames channel
getIncoming() - Method in class io.ktor.http.cio.websocket.WebSocketReader: Channel receiving Websocket's class Frame objects read from byteChannel.
getIncoming() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Incoming frames channel
getKeepAlive() - Method in class io.ktor.http.cio.ConnectionOptions.Companion: An instance for Connection: keep-alive
getKeepAlive() - Method in class io.ktor.http.cio.ConnectionOptions: true
getKnownReason() - Method in class io.ktor.http.cio.websocket.CloseReason: A enum value for this code or null if the code is not listed in enum CloseReason.Codes
getLength() - Method in class io.ktor.http.cio.websocket.FrameParser
getMask() - Method in class io.ktor.http.cio.websocket.FrameParser
getMasking() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
getMasking() - Method in class io.ktor.http.cio.websocket.RawWebSocket: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
getMasking() - Method in class io.ktor.http.cio.websocket.Serializer
getMasking() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
getMasking() - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Whether it will mask serialized frames.
getMaskKey() - Method in class io.ktor.http.cio.websocket.FrameParser
getMaxFrameSize() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Specifies frame size limit. Connection will be closed if violated
getMaxFrameSize() - Method in class io.ktor.http.cio.websocket.RawWebSocket: Specifies frame size limit. Connection will be closed if violated
getMaxFrameSize() - Method in class io.ktor.http.cio.websocket.WebSocketReader: maximum frame size that could be read
getMaxFrameSize() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Specifies frame size limit. Connection will be closed if violated
getMessage() - Method in class io.ktor.http.cio.websocket.CloseReason: a close reason message, could be empty
getMessage() - Method in exception io.ktor.http.cio.websocket.WebSocketReader.FrameTooBigException
getMethod() - Method in class io.ktor.http.cio.Request
getOpcode() - Method in enum io.ktor.http.cio.websocket.FrameType: frame type id that is used to transport it
getOutgoing() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.
getOutgoing() - Method in class io.ktor.http.cio.websocket.RawWebSocket: Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.
getOutgoing() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.
getOutgoing() - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Channel for sending Websocket's class Frame that will be serialized and written to writeChannel.
getPingIntervalMillis() - Method in interface io.ktor.http.cio.websocket.DefaultWebSocketSession: Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
getPingIntervalMillis() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
getPool() - Method in class io.ktor.http.cio.websocket.WebSocketWriter: ByteBuffer pool to be used by this writer
getRemainingCapacity() - Method in class io.ktor.http.cio.websocket.Serializer
getRequestHandlerCoroutine() - Static method in class io.ktor.http.cio.PipelineKt: HTTP request handler coroutine name
getSize() - Method in class io.ktor.http.cio.HttpHeadersMap
getStart() - Method in class io.ktor.http.cio.internals.MutableRange: points to the first character
getStatus() - Method in class io.ktor.http.cio.Response
getStatusText() - Method in class io.ktor.http.cio.Response
getTimeoutMillis() - Method in class io.ktor.http.cio.internals.WeakTimeoutQueue
getTimeoutMillis() - Method in interface io.ktor.http.cio.websocket.DefaultWebSocketSession: A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).
getTimeoutMillis() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: A timeout to wait for pong reply to ping otherwise the session will be terminated immediately.
getUpgrade() - Method in class io.ktor.http.cio.ConnectionOptions.Companion: An instance for Connection: upgrade
getUpgrade() - Method in class io.ktor.http.cio.ConnectionOptions: true
getUri() - Method in class io.ktor.http.cio.Request
getVersion() - Method in class io.ktor.http.cio.Request
getVersion() - Method in class io.ktor.http.cio.Response
goingAway(message, p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Close session with GOING_AWAY reason

H

handle(bb) - Method in class io.ktor.http.cio.websocket.SimpleFrameCollector
hashCode() - Method in class io.ktor.http.cio.ConnectionOptions
hashCode() - Method in class io.ktor.http.cio.websocket.CloseReason
headerLine(name, value) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append header line
HttpBodyKt - Class in io.ktor.http.cio
HttpByteBufferPoolKt - Class in io.ktor.http.cio.internals
HttpHeadersMap - Class in io.ktor.http.cio: A headers map data structure used in CIO
HttpHeadersMapKt - Class in io.ktor.http.cio
HttpMessage - Class in io.ktor.http.cio: Represents a base HTTP message type for request and response
HttpParserKt - Class in io.ktor.http.cio

I

invoke($this, cause) - Static method in class io.ktor.http.cio.internals.Registration.DefaultImpls
invoke(cause) - Method in interface io.ktor.http.cio.internals.WeakTimeoutQueue.Registration
io.ktor.http.cio - package io.ktor.http.cio
io.ktor.http.cio.internals - package io.ktor.http.cio.internals
io.ktor.http.cio.websocket - package io.ktor.http.cio.websocket
isEmpty() - Method in class io.ktor.http.cio.CIOHeaders

L

lastHttpRequest(http11, connectionOptions) - Static method in class io.ktor.http.cio.PipelineKt: Deprecated.
line(line) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append a line

M

MultipartEvent - Class in io.ktor.http.cio: Represents a multipart content starting event. Every part need to be completely consumed or released via MultipartEvent.release
MultipartEvent.Epilogue - Class in io.ktor.http.cio: Represents a multipart content epilogue. A multipart stream could have at most one epilogue.
MultipartEvent.MultipartPart - Class in io.ktor.http.cio: Represents a multipart part. There could be any number of parts in a multipart stream. Please note that it is important to consume body otherwise multipart parser could get stuck (suspend) so you will not receive more events.
MultipartEvent.Preamble - Class in io.ktor.http.cio: Represents a multipart content preamble. A multipart stream could have at most one preamble.
MultipartKt - Class in io.ktor.http.cio
MultipartPart(headers, body) - Constructor for class io.ktor.http.cio.MultipartEvent.MultipartPart: Represents a multipart part. There could be any number of parts in a multipart stream. Please note that it is important to consume body otherwise multipart parser could get stuck (suspend) so you will not receive more events.
MutableRange - Class in io.ktor.http.cio.internals: Represents a text range with mutable bounds
MutableRange(start, end) - Constructor for class io.ktor.http.cio.internals.MutableRange: Represents a text range with mutable bounds

N

nameAt(idx) - Method in class io.ktor.http.cio.HttpHeadersMap
names() - Method in class io.ktor.http.cio.CIOHeaders

P

parse(connection) - Method in class io.ktor.http.cio.ConnectionOptions.Companion: Parse Connection header value
parseBoundary(contentType) - Static method in class io.ktor.http.cio.MultipartKt: Parse multipart boundary encoded in contentType header value
parseHeaders(input, p) - Static method in class io.ktor.http.cio.HttpParserKt: Parse http headers. Not applicable to request and response status lines.
parseHttpBody(contentLength, transferEncoding, connectionOptions, input, out, p) - Static method in class io.ktor.http.cio.HttpBodyKt: Parse HTTP request or response body using contentLength, transferEncoding and connectionOptions writing it to out. Usually doesn't fail but closing out channel with error.
parseHttpBody(headers, input, out, p) - Static method in class io.ktor.http.cio.HttpBodyKt: Parse HTTP request or response body using request/response's headers writing it to out. Usually doesn't fail but closing out channel with error.
parseMultipart(coroutineContext, input, headers) - Static method in class io.ktor.http.cio.MultipartKt: Deprecated.
parseMultipart($receiver, input, headers) - Static method in class io.ktor.http.cio.MultipartKt: Starts a multipart parser coroutine producing multipart events
parseMultipart(coroutineContext, input, contentType, contentLength) - Static method in class io.ktor.http.cio.MultipartKt: Deprecated.
parseMultipart($receiver, input, contentType, contentLength) - Static method in class io.ktor.http.cio.MultipartKt: Starts a multipart parser coroutine producing multipart events
parseMultipart(coroutineContext, boundaryPrefixed, input, totalLength) - Static method in class io.ktor.http.cio.MultipartKt: Deprecated.
parseMultipart($receiver, boundaryPrefixed, input, totalLength) - Static method in class io.ktor.http.cio.MultipartKt: Starts a multipart parser coroutine producing multipart events
parsePart(boundaryPrefixed, input, output, limit, p) - Static method in class io.ktor.http.cio.MultipartKt: Parse multipart part headers and body. Body bytes will be copied to output but up to limit bytes
parsePartBody(boundaryPrefixed, input, output, headers, limit, p) - Static method in class io.ktor.http.cio.MultipartKt: Parse multipart part body copying them to output channel but up to limit bytes
parsePartHeaders(input, p) - Static method in class io.ktor.http.cio.MultipartKt: Parse multipart part headers
parsePreamble(boundaryPrefixed, input, output, limit, p) - Static method in class io.ktor.http.cio.MultipartKt: Parse a multipart preamble
parseRequest(input, p) - Static method in class io.ktor.http.cio.HttpParserKt: Parse an HTTP request line and headers
parseResponse(input, p) - Static method in class io.ktor.http.cio.HttpParserKt: Parse an HTTP response status line and headers
ParserException - Exception in io.ktor.http.cio: An HTTP parser exception
ParserException(message) - Constructor for exception io.ktor.http.cio.ParserException: An HTTP parser exception
Ping(buffer) - Constructor for class io.ktor.http.cio.websocket.Frame.Ping: Represents a low-level ping frame. Could be sent to test connection (peer should reply with class Frame.Pong). Usually there is no need to send/handle it unless you have a RAW web socket session.
Ping(packet) - Constructor for class io.ktor.http.cio.websocket.Frame.Ping
pinger($receiver, outgoing, periodMillis, timeoutMillis, pool) - Static method in class io.ktor.http.cio.websocket.PingPongKt: Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client's pong frames. It is also handling timeoutMillis and sending timeout close frame
PingPongKt - Class in io.ktor.http.cio.websocket
PipelineKt - Class in io.ktor.http.cio
Pong(buffer, disposableHandle) - Constructor for class io.ktor.http.cio.websocket.Frame.Pong: Represents a low-level pong frame. Should be sent in reply to a class Frame.Ping frame. Usually there is no need to send/handle it unless you have a RAW web socket session.
Pong(buffer) - Constructor for class io.ktor.http.cio.websocket.Frame.Pong
Pong(packet) - Constructor for class io.ktor.http.cio.websocket.Frame.Pong
ponger(session, pool) - Static method in class io.ktor.http.cio.websocket.PingPongKt: Deprecated.
ponger($receiver, outgoing, pool) - Static method in class io.ktor.http.cio.websocket.PingPongKt: Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client's ping frame and replying with corresponding pong
Preamble(body) - Constructor for class io.ktor.http.cio.MultipartEvent.Preamble: Represents a multipart content preamble. A multipart stream could have at most one preamble.
process() - Method in class io.ktor.http.cio.internals.WeakTimeoutQueue: Process and cancel all jobs that are timed out
put(nameHash, valueHash, nameStartIndex, nameEndIndex, valueStartIndex, valueEndIndex) - Method in class io.ktor.http.cio.HttpHeadersMap

R

RawWebSocket - Class in io.ktor.http.cio.websocket: Represents a RAW web socket session
RawWebSocket(input, output, maxFrameSize, masking, coroutineContext, pool) - Constructor for class io.ktor.http.cio.websocket.RawWebSocket: Represents a RAW web socket session
RawWebSocketKt - Class in io.ktor.http.cio.websocket
readBytes($receiver) - Static method in class io.ktor.http.cio.websocket.FrameKt: Read binary content from a frame. For fragmented frames only returns this fragment.
readPart(p) - Method in class io.ktor.http.cio.CIOMultipartDataBase
readReason($receiver) - Static method in class io.ktor.http.cio.websocket.FrameKt: Read close reason from close frame or null if no close reason provided
readText($receiver) - Static method in class io.ktor.http.cio.websocket.FrameKt: Read text content from text frame. Shouldn't be used for fragmented frames: such frames need to be reassembled first
register(job) - Method in class io.ktor.http.cio.internals.WeakTimeoutQueue: Register job in this queue. It will be cancelled if doesn't complete in time.
Registration.DefaultImpls - Class in io.ktor.http.cio.internals: WeakTimeoutQueue.register function result
release() - Method in class io.ktor.http.cio.HttpHeadersMap
release() - Method in class io.ktor.http.cio.HttpMessage: Release all memory resources hold by this message
release() - Method in class io.ktor.http.cio.MultipartEvent.Epilogue: Release underlying data/packet.
release() - Method in class io.ktor.http.cio.MultipartEvent.MultipartPart: Release underlying data/packet.
release() - Method in class io.ktor.http.cio.MultipartEvent.Preamble: Release underlying data/packet.
release() - Method in class io.ktor.http.cio.MultipartEvent: Release underlying data/packet.
release() - Method in class io.ktor.http.cio.RequestResponseBuilder: Release all resources hold by the builder
Request - Class in io.ktor.http.cio: Represents an HTTP request
requestLine(method, uri, version) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append request line
RequestResponseBuilder - Class in io.ktor.http.cio: Builds an HTTP request or response
RequestResponseBuilder() - Constructor for class io.ktor.http.cio.RequestResponseBuilder: Builds an HTTP request or response
RequestResponseBuilderKt - Class in io.ktor.http.cio
Response - Class in io.ktor.http.cio: Represents an HTTP response
responseLine(version, status, statusText) - Method in class io.ktor.http.cio.RequestResponseBuilder: Append response status line
run($receiver, handler, p) - Static method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImplKt

S

send(frame, p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Enqueue frame, may suspend if outgoing queue is full. May throw an exception if outgoing channel is already closed so it is impossible to transfer any message. Frames that were sent after close frame could be silently ignored. Please note that close frame could be sent automatically in reply to a peer close frame unless it is raw websocket session.
send($this, frame, p) - Static method in class io.ktor.http.cio.websocket.WebSocketSession.DefaultImpls: Enqueue frame, may suspend if outgoing queue is full. May throw an exception if outgoing channel is already closed so it is impossible to transfer any message. Frames that were sent after close frame could be silently ignored. Please note that close frame could be sent automatically in reply to a peer close frame unless it is raw websocket session.
send(frame, p) - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Enqueue frame, may suspend if outgoing queue is full. May throw an exception if outgoing channel is already closed so it is impossible to transfer any message. Frames that were sent after close frame could be silently ignored. Please note that close frame could be sent automatically in reply to a peer close frame unless it is raw websocket session.
send($receiver, content, p) - Static method in class io.ktor.http.cio.websocket.WebSocketSessionKt: Enqueues a text frame for sending with the specified content.
send($receiver, content, p) - Static method in class io.ktor.http.cio.websocket.WebSocketSessionKt: Enqueues a final binary frame for sending with the specified content.
send(frame, p) - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Send a frame and write it and all outstanding frames in the queue
serialize(buffer) - Method in class io.ktor.http.cio.websocket.Serializer
Serializer - Class in io.ktor.http.cio.websocket
Serializer() - Constructor for class io.ktor.http.cio.websocket.Serializer
setEnd(p) - Method in class io.ktor.http.cio.internals.MutableRange: points to the next character after the last one
setMasking(p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
setMasking(p) - Method in class io.ktor.http.cio.websocket.RawWebSocket: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
setMasking(p) - Method in class io.ktor.http.cio.websocket.Serializer
setMasking(p) - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
setMasking(p) - Method in class io.ktor.http.cio.websocket.WebSocketWriter: Whether it will mask serialized frames.
setMaxFrameSize(p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Specifies frame size limit. Connection will be closed if violated
setMaxFrameSize(p) - Method in class io.ktor.http.cio.websocket.RawWebSocket: Specifies frame size limit. Connection will be closed if violated
setMaxFrameSize(p) - Method in class io.ktor.http.cio.websocket.WebSocketReader: maximum frame size that could be read
setMaxFrameSize(p) - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Specifies frame size limit. Connection will be closed if violated
setPingIntervalMillis(p) - Method in interface io.ktor.http.cio.websocket.DefaultWebSocketSession: Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
setPingIntervalMillis(newValue) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
setStart(p) - Method in class io.ktor.http.cio.internals.MutableRange: points to the first character
setTimeoutMillis(p) - Method in interface io.ktor.http.cio.websocket.DefaultWebSocketSession: A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).
setTimeoutMillis(p) - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: A timeout to wait for pong reply to ping otherwise the session will be terminated immediately.
SimpleFrameCollector - Class in io.ktor.http.cio.websocket
SimpleFrameCollector() - Constructor for class io.ktor.http.cio.websocket.SimpleFrameCollector
start($receiver, handler, p) - Static method in class io.ktor.http.cio.websocket.RawWebSocketKt
start(length, bb) - Method in class io.ktor.http.cio.websocket.SimpleFrameCollector
startConnectionPipeline(input, output, parentJob, ioContext, callContext, timeout, handler) - Static method in class io.ktor.http.cio.PipelineKt: Deprecated.
startConnectionPipeline($receiver, input, output, timeout, handler) - Static method in class io.ktor.http.cio.PipelineKt: Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature
State() - Constructor for enum io.ktor.http.cio.websocket.FrameParser.State

T

take(maskKey) - Method in class io.ktor.http.cio.websocket.SimpleFrameCollector
terminate() - Method in class io.ktor.http.cio.websocket.DefaultWebSocketSessionImpl: Initiate connection termination immediately. Termination may complete asynchronously.
terminate() - Method in class io.ktor.http.cio.websocket.RawWebSocket: Initiate connection termination immediately. Termination may complete asynchronously.
terminate() - Method in interface io.ktor.http.cio.websocket.WebSocketSession: Initiate connection termination immediately. Termination may complete asynchronously.
Text(fin, buffer) - Constructor for class io.ktor.http.cio.websocket.Frame.Text: Represents an application level text frame. In a RAW web socket session a big text frame could be fragmented (separated into several text frames so they have fin = false except the last one). Please note that a boundary between fragments could be in the middle of multi-byte (unicode) character so don't apply String constructor to every fragment but use decoder loop instead of concatenate fragments first. Note that usually there is no need to handle fragments unless you have a RAW web socket session.
Text(text) - Constructor for class io.ktor.http.cio.websocket.Frame.Text
Text(fin, packet) - Constructor for class io.ktor.http.cio.websocket.Frame.Text
TokenizerKt - Class in io.ktor.http.cio.internals
toString() - Method in class io.ktor.http.cio.ConnectionOptions
toString() - Method in class io.ktor.http.cio.HttpHeadersMap
toString() - Method in class io.ktor.http.cio.internals.MutableRange
toString() - Method in class io.ktor.http.cio.websocket.CloseReason
toString() - Method in class io.ktor.http.cio.websocket.Frame

U

UtilsKt - Class in io.ktor.http.cio.websocket

V

valueAt(idx) - Method in class io.ktor.http.cio.HttpHeadersMap

W

WeakTimeoutQueue - Class in io.ktor.http.cio.internals: It provides ability to cancel jobs and schedule coroutine with timeout. Unlike regular withTimeout this implementation is never scheduling timer tasks but only checks for current time. This makes timeout measurement much cheaper and doesn't require any watchdog thread.
WeakTimeoutQueue(timeoutMillis, clock) - Constructor for class io.ktor.http.cio.internals.WeakTimeoutQueue: It provides ability to cancel jobs and schedule coroutine with timeout. Unlike regular withTimeout this implementation is never scheduling timer tasks but only checks for current time. This makes timeout measurement much cheaper and doesn't require any watchdog thread.
WeakTimeoutQueue.Registration - Interface in io.ktor.http.cio.internals: WeakTimeoutQueue.register function result
WebSocketInternalAPI - Interface in io.ktor.http.cio.websocket: API marked with this annotation is internal and not intended to be used outside of ktor It is not recommended to use it as it may be changed in the future without notice or it may be too low-level so could damage your data.
WebSocketReader - Class in io.ktor.http.cio.websocket: Class that continuously reads a byteChannel and converts into Websocket class Frame exposing them in WebSocketReader.getIncoming.
WebSocketReader(byteChannel, coroutineContext, maxFrameSize, pool) - Constructor for class io.ktor.http.cio.websocket.WebSocketReader: Class that continuously reads a byteChannel and converts into Websocket class Frame exposing them in WebSocketReader.getIncoming.
WebSocketReader(byteChannel, maxFrameSize, parent, coroutineContext, pool) - Constructor for class io.ktor.http.cio.websocket.WebSocketReader: Deprecated.
WebSocketReader.FrameTooBigException - Exception in io.ktor.http.cio.websocket: Raised when the frame is bigger than allowed in a current websocket session
WebSocketSession - Interface in io.ktor.http.cio.websocket: Represents a web socket session between two peers
WebSocketSession.DefaultImpls - Class in io.ktor.http.cio.websocket: Represents a web socket session between two peers
WebSocketSessionKt - Class in io.ktor.http.cio.websocket
WebSocketWriter - Class in io.ktor.http.cio.websocket: Class that processes written WebSocketWriter.getOutgoing Websocket class Frame, serializes them and writes the bits into the writeChannel.
WebSocketWriter(writeChannel, coroutineContext, masking, pool) - Constructor for class io.ktor.http.cio.websocket.WebSocketWriter: Class that processes written WebSocketWriter.getOutgoing Websocket class Frame, serializes them and writes the bits into the writeChannel.
WebSocketWriter(writeChannel, parent, coroutineContext, masking, pool) - Constructor for class io.ktor.http.cio.websocket.WebSocketWriter: Deprecated.
withTimeout(block, p) - Method in class io.ktor.http.cio.internals.WeakTimeoutQueue: Execute block and cancel if doesn't complete in time.

B C D E F G H I L M N P R S T U V W