Errors

Connect-Kotlin uses a set of 16 error codes. These are similar to the "404 Not Found" and "500 Internal Server Error" HTTP status codes that are more familiar.

In the Connect protocol, an error is always represented as JSON on the wire. For example:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": "invalid_argument",
    "message": "sentence cannot be empty"
}

Connect-Kotlin provides a common ConnectError type that represents errors consistently across all supported protocols.

ResponseMessage values returned by unary API calls expose an optional ConnectError?, and StreamResult values returned by streaming APIs can also contain this type:

val request = SayRequest(sentence = sentence)
val response = elizaClient.say(request)
response.error {
  print(error.code) // Code.INVALID_ARGUMENT
  print(error.message) // "sentence cannot be empty"
  print(error.metadata) // Dictionary of additional server-provided headers/trailers
}

Error details

Additional strongly typed errors may be specified by the server in responses. These are wrapped with the google.protobuf.Any type, and can be unpacked using the ConnectError.unpackedDetails() function by specifying the expected error message class type:

val request = SayRequest(sentence = sentence)
val response = elizaClient.say(request)
response.error {
  val errorDetails = error.unpackedDetails(ErrorDetail::class)
  // Work with ErrorDetail.
}

Cancelation

Generated methods have the suspend keyword on the method signature which will cancel the underlying request when the Kotlin Coroutine context is canceled.

With the callback unary signature, the result is a canceling handler to give control to the user to manually cancel a request:

val request = SayRequest(sentence = sentence)
val cancelable = elizaClient.say(request) { response in
  print(response.code) // Code.canceled.
}
cancelable.cancel()