kotlinx-rpc-grpc-core/kotlinx.rpc.grpc

Package-level declarations

Available in a dev version: 0․11․0-grpc-186

How to configure

Types

GrpcCompression

interface GrpcCompression

Represents a compression algorithm for gRPC message encoding.

GrpcMetadata

expect class GrpcMetadata

Provides access to read and write metadata values to be exchanged during a gRPC call.

actual typealias GrpcMetadata = Metadata

typealias GrpcMetadata = Metadata

Provides access to read and write metadata values to be exchanged during a gRPC call.

actual class GrpcMetadata

Provides access to read and write metadata values to be exchanged during a gRPC call.

GrpcMetadataKey

expect class GrpcMetadataKey<T>(name: String, marshaller: GrpcMarshaller<T>)

A typed key for metadata entries that uses a GrpcMarshaller to encode and decode values.

actual class GrpcMetadataKey<T>(name: String, marshaller: GrpcMarshaller<T>)

A typed key for metadata entries that uses a GrpcMarshaller to encode and decode values.

actual class GrpcMetadataKey<T>(name: String, val marshaller: GrpcMarshaller<T>)

A typed key for metadata entries that uses a GrpcMarshaller to encode and decode values.

GrpcStatus

expect class GrpcStatus

Defines the status of an operation by providing a standard GrpcStatusCode in conjunction with an optional descriptive message.

actual typealias GrpcStatus = Status

typealias GrpcStatus = Status

Defines the status of an operation by providing a standard GrpcStatusCode in conjunction with an optional descriptive message.

actual class GrpcStatus

Defines the status of an operation by providing a standard GrpcStatusCode in conjunction with an optional descriptive message.

GrpcStatusCode

enum GrpcStatusCode : Enum<GrpcStatusCode>

Standard gRPC status codes.

GrpcStatusException

expect class GrpcStatusException : Exception

Exception used for propagating gRPC status information in non-OK results.

actual typealias GrpcStatusException = StatusException

typealias GrpcStatusException = StatusException

Exception used for propagating gRPC status information in non-OK results.

actual class GrpcStatusException : Exception

Exception used for propagating gRPC status information in non-OK results.

Properties

description

val GrpcStatus.description: String?

The description of this status, or null if not present.

status

val GrpcStatusException.status: GrpcStatus

The status associated with this exception.

statusCode

expect val GrpcStatus.statusCode: GrpcStatusCode

The status code of this status.

actual val GrpcStatus.statusCode: GrpcStatusCode

The status code of this status.

actual val GrpcStatus.statusCode: GrpcStatusCode

The status code of this status.

trailers

val GrpcStatusException.trailers: GrpcMetadata?

The trailing metadata associated with this exception, or null if not present.

Functions

append

expect fun GrpcMetadata.append(key: String, value: String)

Appends a metadata entry with the given key and value.

expect fun <T> GrpcMetadata.append(key: GrpcMetadataKey<T>, value: T)

Appends a metadata entry with the given typed key and value.

actual fun GrpcMetadata.append(key: String, value: String)

Appends a metadata entry with the given key and value.

actual fun <T> GrpcMetadata.append(key: GrpcMetadataKey<T>, value: T)

Appends a metadata entry with the given typed key and value.

actual fun GrpcMetadata.append(key: String, value: String)

Appends a metadata entry with the given key and value.

actual fun <T> GrpcMetadata.append(key: GrpcMetadataKey<T>, value: T)

Appends a metadata entry with the given typed key and value.

appendBinary

expect fun GrpcMetadata.appendBinary(key: String, value: ByteArray)

Appends a binary metadata entry with the given key and value.

expect fun <T> GrpcMetadata.appendBinary(key: GrpcMetadataKey<T>, value: T)

Appends a binary metadata entry with the given typed key and value.

actual fun GrpcMetadata.appendBinary(key: String, value: ByteArray)

Appends a binary metadata entry with the given key and value.

actual fun <T> GrpcMetadata.appendBinary(key: GrpcMetadataKey<T>, value: T)

Appends a binary metadata entry with the given typed key and value.

actual fun GrpcMetadata.appendBinary(key: String, value: ByteArray)

Appends a binary metadata entry with the given key and value.

actual fun <T> GrpcMetadata.appendBinary(key: GrpcMetadataKey<T>, value: T)

Appends a binary metadata entry with the given typed key and value.

asException

fun GrpcStatus.asException(trailers: GrpcMetadata? = null): GrpcStatusException

Converts this status to a GrpcStatusException with optional trailers.

contains

expect operator fun GrpcMetadata.contains(key: String): Boolean

Returns true if this metadata contains one or more values for the specified key.

actual operator fun GrpcMetadata.contains(key: String): Boolean

Returns true if this metadata contains one or more values for the specified key.

actual operator fun GrpcMetadata.contains(key: String): Boolean

Returns true if this metadata contains one or more values for the specified key.

copy

fun GrpcMetadata.copy(): GrpcMetadata

Creates a copy of this metadata containing all entries.

get

expect operator fun GrpcMetadata.get(key: String): String?

Returns the last metadata entry added with the given key, or null if there are no entries.

expect operator fun <T> GrpcMetadata.get(key: GrpcMetadataKey<T>): T?

Returns the last metadata entry added with the given typed key, or null if there are no entries.

actual operator fun GrpcMetadata.get(key: String): String?

Returns the last metadata entry added with the given key, or null if there are no entries.

actual operator fun <T> GrpcMetadata.get(key: GrpcMetadataKey<T>): T?

Returns the last metadata entry added with the given typed key, or null if there are no entries.

actual operator fun GrpcMetadata.get(key: String): String?

Returns the last metadata entry added with the given key, or null if there are no entries.

actual operator fun <T> GrpcMetadata.get(key: GrpcMetadataKey<T>): T?

Returns the last metadata entry added with the given typed key, or null if there are no entries.

getAll

expect fun GrpcMetadata.getAll(key: String): List<String>

Returns all metadata entries with the given key, in the order they were added.

expect fun <T> GrpcMetadata.getAll(key: GrpcMetadataKey<T>): List<T>

Returns all metadata entries with the given typed key, in the order they were added.

actual fun GrpcMetadata.getAll(key: String): List<String>

Returns all metadata entries with the given key, in the order they were added.

actual fun <T> GrpcMetadata.getAll(key: GrpcMetadataKey<T>): List<T>

Returns all metadata entries with the given typed key, in the order they were added.

actual fun GrpcMetadata.getAll(key: String): List<String>

Returns all metadata entries with the given key, in the order they were added.

actual fun <T> GrpcMetadata.getAll(key: GrpcMetadataKey<T>): List<T>

Returns all metadata entries with the given typed key, in the order they were added.

getAllBinary

expect fun GrpcMetadata.getAllBinary(key: String): List<ByteArray>

Returns all binary metadata entries with the given key, in the order they were added.

expect fun <T> GrpcMetadata.getAllBinary(key: GrpcMetadataKey<T>): List<T>

Returns all binary metadata entries with the given typed key, in the order they were added.

actual fun GrpcMetadata.getAllBinary(key: String): List<ByteArray>

Returns all binary metadata entries with the given key, in the order they were added.

actual fun <T> GrpcMetadata.getAllBinary(key: GrpcMetadataKey<T>): List<T>

Returns all binary metadata entries with the given typed key, in the order they were added.

actual fun GrpcMetadata.getAllBinary(key: String): List<ByteArray>

Returns all binary metadata entries with the given key, in the order they were added.

actual fun <T> GrpcMetadata.getAllBinary(key: GrpcMetadataKey<T>): List<T>

Returns all binary metadata entries with the given typed key, in the order they were added.

getBinary

expect fun GrpcMetadata.getBinary(key: String): ByteArray?

Returns the last binary metadata entry added with the given key, or null if there are no entries.

expect fun <T> GrpcMetadata.getBinary(key: GrpcMetadataKey<T>): T?

Returns the last binary metadata entry added with the given typed key, or null if there are no entries.

actual fun GrpcMetadata.getBinary(key: String): ByteArray?

Returns the last binary metadata entry added with the given key, or null if there are no entries.

actual fun <T> GrpcMetadata.getBinary(key: GrpcMetadataKey<T>): T?

Returns the last binary metadata entry added with the given typed key, or null if there are no entries.

actual fun GrpcMetadata.getBinary(key: String): ByteArray?

Returns the last binary metadata entry added with the given key, or null if there are no entries.

actual fun <T> GrpcMetadata.getBinary(key: GrpcMetadataKey<T>): T?

Returns the last binary metadata entry added with the given typed key, or null if there are no entries.

GrpcMetadata

fun GrpcMetadata(block: GrpcMetadata.() -> Unit): GrpcMetadata

Constructs and configures a new GrpcMetadata instance. The provided block is executed to apply custom modifications to the metadata object.

GrpcStatus

expect fun GrpcStatus(code: GrpcStatusCode, description: String? = null, cause: Throwable? = null): GrpcStatus

Creates a GrpcStatus with the specified code, optional description, and cause.

actual fun GrpcStatus(code: GrpcStatusCode, description: String?, cause: Throwable?): GrpcStatus

Creates a GrpcStatus with the specified code, optional description, and cause.

actual fun GrpcStatus(code: GrpcStatusCode, description: String?, cause: Throwable?): GrpcStatus

Creates a GrpcStatus with the specified code, optional description, and cause.

keys

expect fun GrpcMetadata.keys(): Set<String>

Returns an immutable set of all keys present in this metadata.

actual fun GrpcMetadata.keys(): Set<String>

Returns an immutable set of all keys present in this metadata.

actual fun GrpcMetadata.keys(): Set<String>

Returns an immutable set of all keys present in this metadata.

merge

expect fun GrpcMetadata.merge(other: GrpcMetadata)

Merges all entries from other metadata into this metadata.

actual fun GrpcMetadata.merge(other: GrpcMetadata)

Merges all entries from other metadata into this metadata.

actual fun GrpcMetadata.merge(other: GrpcMetadata)

Merges all entries from other metadata into this metadata.

plus

operator fun GrpcMetadata.plus(other: GrpcMetadata): GrpcMetadata

Creates a new metadata instance containing all entries from this metadata and other.

plusAssign

operator fun GrpcMetadata.plusAssign(other: GrpcMetadata)

Merges all entries from other metadata into this metadata using the += operator.

remove

expect fun GrpcMetadata.remove(key: String, value: String): Boolean

Removes the first occurrence of the specified value for the given key.

expect fun <T> GrpcMetadata.remove(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified value for the given typed key.

actual fun GrpcMetadata.remove(key: String, value: String): Boolean

Removes the first occurrence of the specified value for the given key.

actual fun <T> GrpcMetadata.remove(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified value for the given typed key.

actual fun GrpcMetadata.remove(key: String, value: String): Boolean

Removes the first occurrence of the specified value for the given key.

actual fun <T> GrpcMetadata.remove(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified value for the given typed key.

removeAll

expect fun GrpcMetadata.removeAll(key: String): List<String>

Removes all values for the given key and returns them.

expect fun <T> GrpcMetadata.removeAll(key: GrpcMetadataKey<T>): List<T>

Removes all values for the given typed key and returns them.

actual fun GrpcMetadata.removeAll(key: String): List<String>

Removes all values for the given key and returns them.

actual fun <T> GrpcMetadata.removeAll(key: GrpcMetadataKey<T>): List<T>

Removes all values for the given typed key and returns them.

actual fun GrpcMetadata.removeAll(key: String): List<String>

Removes all values for the given key and returns them.

actual fun <T> GrpcMetadata.removeAll(key: GrpcMetadataKey<T>): List<T>

Removes all values for the given typed key and returns them.

removeAllBinary

expect fun GrpcMetadata.removeAllBinary(key: String): List<ByteArray>

Removes all binary values for the given key and returns them.

expect fun <T> GrpcMetadata.removeAllBinary(key: GrpcMetadataKey<T>): List<T>

actual fun GrpcMetadata.removeAllBinary(key: String): List<ByteArray>

Removes all binary values for the given key and returns them.

actual fun <T> GrpcMetadata.removeAllBinary(key: GrpcMetadataKey<T>): List<T>

actual fun GrpcMetadata.removeAllBinary(key: String): List<ByteArray>

Removes all binary values for the given key and returns them.

actual fun <T> GrpcMetadata.removeAllBinary(key: GrpcMetadataKey<T>): List<T>

removeBinary

expect fun GrpcMetadata.removeBinary(key: String, value: ByteArray): Boolean

Removes the first occurrence of the specified binary value for the given key.

expect fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified binary value for the given typed key.

actual fun GrpcMetadata.removeBinary(key: String, value: ByteArray): Boolean

Removes the first occurrence of the specified binary value for the given key.

actual fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified binary value for the given typed key.

actual fun GrpcMetadata.removeBinary(key: String, value: ByteArray): Boolean

Removes the first occurrence of the specified binary value for the given key.

actual fun <T> GrpcMetadata.removeBinary(key: GrpcMetadataKey<T>, value: T): Boolean

Removes the first occurrence of the specified binary value for the given typed key.