commonMain.io.github.xlopec.tea.time.travel.session.SessionBuilder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tea-time-travel-jvm Show documentation

TEA Bag is simple implementation of TEA written in Kotlin. Tea-time-travel is part of this project

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2022. Maksym Oliinyk.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

@file:Suppress("FunctionName")

package io.github.xlopec.tea.time.travel.session

import io.github.xlopec.tea.time.travel.component.Settings
import io.ktor.client.*
import io.ktor.client.plugins.websocket.*
import io.ktor.http.*
import io.ktor.http.HttpMethod.Companion.Get

/**
 * Function that for a given server settings creates a new connection
 * to a debug server
 *
 * @param M message type
 * @param S state type
 * @param J json type
 */
public typealias SessionFactory = suspend (
    settings: Settings,
    session: suspend DebugSession.() -> Unit,
) -> Unit

/**
 * Creates a new web socket session using supplied settings
 *
 * @receiver configured [HttpClient] instance. **Web socket** feature must be installed and configured for http client
 * @param settings server settings
 * @param block lambda to interact with [session][DebugSession]
 * @param M message type
 * @param S state type
 * @param J json type
 */
public suspend inline fun  HttpClient.session(
    settings: Settings,
    crossinline block: suspend DebugSession.() -> Unit,
) { // todo add timeout
    ws(
        method = Get,
        host = settings.url.host,
        port = settings.url.port,
    ) {
        with(DebugWebSocketSession(M::class, S::class, settings, this)) {
            block()
        }
    }
}

@PublishedApi
internal val HttpClient: HttpClient by lazy { HttpClient { install(WebSockets) } }

@PublishedApi
internal val Localhost: Url by lazy { Url("http://localhost:8080") }