Docs

Author: Lipen

jacodb-ets/wire-client/src/main/kotlin/org/jacodb/ets/service/GrpcClient.kt

@@ -23,6 +23,21 @@ import okhttp3.Protocol
 
 const val DEFAULT_PORT = 7777
 
+/**
+ * Creates a gRPC client with the specified port.
+ *
+ * ### Example:
+ * ```kotlin
+ * val client = grpcClient(7777)
+ * ```
+ *
+ * ### Note:
+ * You probably want to use [createGrpcClient] instead,
+ * which is more convenient for creating specific clients.
+ *
+ * @param port The port on which the gRPC server is running.
+ * @return A configured [GrpcClient] instance.
+ */
 fun grpcClient(port: Int = DEFAULT_PORT): GrpcClient {
     val okClient = OkHttpClient.Builder()
         .protocols(listOf(Protocol.H2_PRIOR_KNOWLEDGE))
@@ -33,6 +48,17 @@ fun grpcClient(port: Int = DEFAULT_PORT): GrpcClient {
         .build()
 }
 
+/**
+ * Creates a gRPC client for the specified service type.
+ *
+ * ### Example:
+ * ```kotlin
+ * val client = createGrpcClient<MyServiceClient>(7777)
+ * ```
+ *
+ * @param port The port on which the gRPC server is running.
+ * @return A configured instance of the specified service type [T].
+ */
 inline fun <reified T : Service> createGrpcClient(port: Int = DEFAULT_PORT): T {
     return grpcClient(port).create()
 }