//ktor-sse-examplebywattanx

ktor-sse-example

0
0
0
Kotlin

This is a Kotlin Multiplatform project targeting Android, iOS.

  • /composeApp is for code that will be shared across your Compose Multiplatform applications.
    It contains several subfolders:

    • commonMain is for code that’s common for all targets.
    • Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
      For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
      the iosMain folder would be the right place for such calls.
      Similarly, if you want to edit the Desktop (JVM) specific part, the jvmMain
      folder is the appropriate location.
  • /iosApp contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
    you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.

  • /shared is for the code that will be shared between all targets in the project.
    The most important subfolder is commonMain. If preferred, you
    can add code to the platform-specific folders here too.

Build and Run Android Application

To build and run the development version of the Android app, use the run configuration from the run widget
in your IDE’s toolbar or build it directly from the terminal:

  • on macOS/Linux
    ./gradlew :composeApp:assembleDebug
    
  • on Windows
    .\gradlew.bat :composeApp:assembleDebug
    

Build and Run iOS Application

To build and run the development version of the iOS app, use the run configuration from the run widget
in your IDE’s toolbar or open the /iosApp directory in Xcode and run it from there.


SSE Sample Implementation

This project includes a Server-Sent Events (SSE) sample implementation using Ktor Client.

Features

  • Kotlin Multiplatform shared SSE client
  • Android UI with Jetpack Compose
  • iOS UI with SwiftUI
  • Real-time event streaming

Setup

Backend Server

You need to run an SSE server on http://localhost:8080/sse for testing.

Example SSE server response format:

data: {"message": "Hello from server"}

id: 1
event: update
data: {"message": "Update message"}

Running the Apps

undefinedAndroid:undefined

./gradlew :composeApp:assembleDebug

undefinediOS:undefined
Open iosApp directory in Xcode and run.

Architecture

  • undefinedshared/: SSE client logic (Ktor Client with SSE plugin)
    • SseClient.kt: Main SSE client implementation
    • ConnectionState.kt: Connection state definitions
    • SseEvent.kt: Event data model
  • undefinedcomposeApp/: Android UI (Jetpack Compose)
    • SseScreen.kt: Android UI screen
  • undefinediosApp/: iOS UI (SwiftUI)
    • ContentView.swift: iOS UI screen

Dependencies

  • Ktor Client 3.0.3
  • Ktor SSE Plugin
  • Kotlinx Coroutines 1.10.1
  • Platform-specific engines: OkHttp (Android), Darwin (iOS)

References


Learn more about Kotlin Multiplatform

[beta]v0.14.0