micro_utils.dokka/dev.inmo.micro_utils.ktor.server

Package-level declarations

Types

class TemporalFilesRoutingConfigurator(subpath: String = DefaultTemporalFilesSubPath, temporalFilesUtilizer: TemporalFilesRoutingConfigurator.TemporalFilesUtilizer = TemporalFilesUtilizer, filesFlowReplay: Int = 0, filesFlowExtraBufferCapacity: Int = Int.MAX_VALUE, filesFlowOnBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND) : ApplicationRoutingConfigurator.Element

Properties

extractFromToDateTime

val ERROR CLASS: Symbol not found for Parameters.extractFromToDateTime: FromToDateTime

Extracts a FromToDateTime range from Ktor server Parameters. Looks for "from" and "to" parameters containing Unix millisecond timestamps.

standardKtorSerialFormatContentType

val standardKtorSerialFormatContentType: ERROR CLASS: Unresolved name: Cbor

Functions

createKtorServer

fun createKtorServer(host: String = "localhost", port: Int = Random.nextInt(1024, 65535), additionalEngineEnvironmentConfigurator: ERROR CLASS: Symbol not found for EngineConnectorBuilder.() -> Unit = {}, additionalConfigurationConfigurator: ERROR CLASS: Symbol not found for CIOApplicationEngine.Configuration.() -> Unit = {}, environment: ERROR CLASS: Symbol not found for ApplicationEnvironment = applicationEnvironment(), block: ERROR CLASS: Symbol not found for Application.() -> Unit): ERROR CLASS: Symbol not found for EmbeddedServer<ERROR CLASS: Symbol not found for CIOApplicationEngine, ERROR CLASS: Symbol not found for CIOApplicationEngine.Configuration>

fun createKtorServer(host: String = "localhost", port: Int = Random.nextInt(1024, 65535), configurators: List<KtorApplicationConfigurator>, additionalEngineEnvironmentConfigurator: ERROR CLASS: Symbol not found for EngineConnectorBuilder.() -> Unit = {}, additionalConfigurationConfigurator: ERROR CLASS: Symbol not found for CIOApplicationEngine.Configuration.() -> Unit = {}, environment: ERROR CLASS: Symbol not found for ApplicationEnvironment = applicationEnvironment()): ERROR CLASS: Symbol not found for EmbeddedServer<ERROR CLASS: Symbol not found for CIOApplicationEngine, ERROR CLASS: Symbol not found for CIOApplicationEngine.Configuration>

Create server with CIO server engine without starting of it

fun <TEngine : ERROR CLASS: Symbol not found for ApplicationEngine, TConfiguration : ERROR CLASS: Symbol not found for ApplicationEngine.Configuration> createKtorServer(engine: ERROR CLASS: Symbol not found for ApplicationEngineFactory<TEngine, TConfiguration>, host: String = "localhost", port: Int = Random.nextInt(1024, 65535), additionalEngineEnvironmentConfigurator: ERROR CLASS: Symbol not found for EngineConnectorBuilder.() -> Unit = {}, additionalConfigurationConfigurator: TConfiguration.() -> Unit = {}, environment: ERROR CLASS: Symbol not found for ApplicationEnvironment = applicationEnvironment(), block: ERROR CLASS: Symbol not found for Application.() -> Unit): ERROR CLASS: Symbol not found for EmbeddedServer<TEngine, TConfiguration>

fun <TEngine : ERROR CLASS: Symbol not found for ApplicationEngine, TConfiguration : ERROR CLASS: Symbol not found for ApplicationEngine.Configuration> createKtorServer(engine: ERROR CLASS: Symbol not found for ApplicationEngineFactory<TEngine, TConfiguration>, host: String = "localhost", port: Int = Random.nextInt(1024, 65535), additionalEngineEnvironmentConfigurator: ERROR CLASS: Symbol not found for EngineConnectorBuilder.() -> Unit = {}, additionalConfigurationConfigurator: TConfiguration.() -> Unit = {}, environment: ERROR CLASS: Symbol not found for ApplicationEnvironment = applicationEnvironment(), configurators: List<KtorApplicationConfigurator>): ERROR CLASS: Symbol not found for EmbeddedServer<TEngine, TConfiguration>

download

suspend fun ERROR CLASS: Symbol not found for PartData.BinaryChannelItem.download(target: File)

fun ERROR CLASS: Symbol not found for PartData.BinaryItem.download(target: File)

fun ERROR CLASS: Symbol not found for PartData.FileItem.download(target: File)

downloadToTemporalFile

suspend fun ERROR CLASS: Symbol not found for PartData.BinaryChannelItem.downloadToTemporalFile(): File

fun ERROR CLASS: Symbol not found for PartData.BinaryItem.downloadToTemporalFile(): File

fun ERROR CLASS: Symbol not found for PartData.FileItem.downloadToTemporalFile(): File

getParameterOrSendError

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.getParameterOrSendError(field: String): MatchGroup?

Retrieves a parameter value by field name from the request parameters. If the parameter is not present, responds with HttpStatusCode.BadRequest (400) and an error message.

getParametersOrSendError

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.getParametersOrSendError(field: String): ERROR CLASS: Cannot infer argument for type parameter T

Retrieves all parameter values by field name from the request parameters. If the parameter is not present, responds with HttpStatusCode.BadRequest (400) and an error message.

getQueryParameter

fun ERROR CLASS: Symbol not found for ApplicationCall.getQueryParameter(field: String): MatchGroup?

Retrieves a query parameter value by field name from the request.

getQueryParameterOrSendError

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.getQueryParameterOrSendError(field: String): MatchGroup?

Retrieves a query parameter value by field name from the request. If the parameter is not present, responds with HttpStatusCode.BadRequest (400) and an error message.

getQueryParameters

fun ERROR CLASS: Symbol not found for ApplicationCall.getQueryParameters(field: String): ERROR CLASS: Unresolved name: getAll

Retrieves all query parameter values by field name from the request.

getQueryParametersOrSendError

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.getQueryParametersOrSendError(field: String): ERROR CLASS: Cannot infer argument for type parameter T

Retrieves all query parameter values by field name from the request. If the parameter is not present, responds with HttpStatusCode.BadRequest (400) and an error message.

handleUniUpload

inline suspend fun ERROR CLASS: Symbol not found for ApplicationCall.handleUniUpload(onFormItem: (ERROR CLASS: Symbol not found for PartData.FormItem) -> Unit = {}, onBinaryContent: (ERROR CLASS: Symbol not found for PartData.BinaryItem) -> Unit = {}, onBinaryChannelItem: (ERROR CLASS: Symbol not found for PartData.BinaryChannelItem) -> Unit = {}, onFileItem: (ERROR CLASS: Symbol not found for PartData.FileItem) -> Unit = {})

Server-side part which receives dev.inmo.micro_utils.ktor.client.uniUpload request

includeWebsocketHandling

inline fun <T : Any> ERROR CLASS: Symbol not found for Route.includeWebsocketHandling(suburl: String, flow: Flow<T>, protocol: ERROR CLASS: Symbol not found for URLProtocol?? = null, noinline dataMapper: suspend ERROR CLASS: Symbol not found for WebSocketServerSession.(T) -> T? = { it })

respondOrNoContent

inline suspend fun <T : Any> ERROR CLASS: Symbol not found for ApplicationCall.respondOrNoContent(data: T?)

Responds with the given data if it's not null, or responds with HttpStatusCode.NoContent (204) if it's null. This is useful for API endpoints that may return empty results.

uniloadMultipart

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.uniloadMultipart(onFormItem: (ERROR CLASS: Symbol not found for PartData.FormItem) -> Unit = {}, onCustomFileItem: (ERROR CLASS: Symbol not found for PartData.FileItem) -> Unit = {}, onBinaryChannelItem: (ERROR CLASS: Symbol not found for PartData.BinaryChannelItem) -> Unit = {}, onBinaryContent: (ERROR CLASS: Symbol not found for PartData.BinaryItem) -> Unit = {}): ERROR CLASS: Symbol not found for Input

uniloadMultipartFile

suspend fun ERROR CLASS: Symbol not found for ApplicationCall.uniloadMultipartFile(onFormItem: (ERROR CLASS: Symbol not found for PartData.FormItem) -> Unit = {}, onCustomFileItem: (ERROR CLASS: Symbol not found for PartData.FileItem) -> Unit = {}, onBinaryChannelItem: (ERROR CLASS: Symbol not found for PartData.BinaryChannelItem) -> Unit = {}, onBinaryContent: (ERROR CLASS: Symbol not found for PartData.BinaryItem) -> Unit = {}): MPPFile