Docs

Author: Lipen

jacodb-ets/src/test/kotlin/org/jacodb/ets/test/WireTest.kt

@@ -19,6 +19,7 @@ package org.jacodb.ets.test
 import greeter.GreeterClient
 import greeter.HelloRequest
 import mu.KotlinLogging
+import org.jacodb.ets.service.GreeterService
 import org.jacodb.ets.service.createGrpcClient
 import org.jacodb.ets.service.grpcServer
 import kotlin.test.Test
@@ -32,7 +33,9 @@ class WireTest {
 
     @Test
     fun `test Greeter`() {
-        val server = grpcServer(PORT)
+        val server = grpcServer(PORT) {
+            addService(GreeterService())
+        }
         server.start()
         logger.info { "Server listening on port ${server.port}" }
 

jacodb-ets/wire-server/src/main/kotlin/org/jacodb/ets/service/Server.kt

@@ -20,10 +20,26 @@ import io.grpc.Server
 import io.grpc.ServerBuilder
 import io.grpc.protobuf.services.ProtoReflectionService
 
+/**
+ * Creates a gRPC server with the specified port and optional reflection service.
+ *
+ * ### Example:
+ * ```kotlin
+ * val server = grpcServer(7777) {
+ *     addService(MyService())
+ * }
+ * ```
+ *
+ * @param port The port on which the server will listen.
+ * @param addReflection Whether to add the [ProtoReflectionService] for introspection (see [gRPC Reflection](https://grpc.io/docs/guides/reflection/)).
+ * @param setup A lambda to configure the server, where you can add services and other configurations.
+ * @return A configured [Server] instance.
+ */
 fun grpcServer(
     port: Int,
     addReflection: Boolean = true,
-    setup: ServerBuilder<*>.() -> Unit = {},
+    setup: ServerBuilder<*>.() -> Unit,
+    // Note: `setup` is not `= {}` by default because you probably want to add at least one service.
 ): Server = ServerBuilder
     .forPort(port)
     .apply(setup)