clientprotocol/org.inthewaves.kotlinsignald.clientprotocol

Package org.inthewaves.kotlinsignald.clientprotocol

Types

actual typealias AutoCloseable = AutoCloseable

open class RequestFailedException(responseJsonString: String?, errorBody: JsonObject?, errorType: String?, exception: String?, extraMessage: String?, cause: Throwable?) : SignaldException

An exception that is thrown if the resulting JSON can't be deserialized or the socket returns an error response.

SignaldException

expect open class SignaldException : Exception

actual typealias SignaldException = IOException

actual open class SignaldException : Exception

SocketCommunicator

interface SocketCommunicator : AutoCloseable

An interface to facilitate communication with signald socket. The implementation might close socket connections after making a request, in which case, the readLine function will not be supported.

SuspendSocketCommunicator

interface SuspendSocketCommunicator : AutoCloseable

An interface to facilitate communication with signald socket. The implementation might close socket connections after making a request, in which case, the readLineSuspend function will not be supported.

Properties

SignaldJson

val SignaldJson: Json

The Json instance used to serialize and deserialize signald requests and responses. We set it to ignore unknown keys for forward compatibility reasons.