Agones Client SDK/net.scrayos.agones.client/AgonesSdk/Beta

Beta

The Beta-Channel provides the interfaces of the Agones SDK that may have already been extensively tested and have been activated by default, but they haven't been used broadly enough to promote them to the Stable-Channel yet. But the provided endpoints can be used without any restrictions or preparations and only very few bugs are expected. As soon as the features have been tested enough and have proven to be useful to the Agones system, they will be promoted to the Stable-Channel. The Beta-Channel can be retrieved through beta from an instance of the Agones SDK.

Inheritors

GrpcBeta

Functions

addListValue

abstract suspend fun addListValue(name: String, value: String)

Adds the supplied value to the list with the supplied name. If no list with this name exists, the entry already exists in the list, or this operation would grow the corresponding list above the current capacity, an appropriate exception will be thrown.

counterCapacity

abstract suspend fun counterCapacity(name: String): Long

Retrieves the current capacity of the counter with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no counter with this name exists, an appropriate exception will be thrown.

abstract suspend fun counterCapacity(name: String, capacity: Long)

Sets a new capacity for the counter with the supplied name. If no counter with this name exists or the capacity is not in the interval [0, Long.MAX_VALUE], an appropriate exception will be thrown.

counterCount

abstract suspend fun counterCount(name: String): Long

Retrieves the current count of the counter with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no counter with this name exists, an appropriate exception will be thrown.

abstract suspend fun counterCount(name: String, value: Long)

Sets a new count for the counter with the supplied name. If no counter with this name exists or the value is not in the interval [0, capacity], an appropriate exception will be thrown.

decrementCounter

abstract suspend fun decrementCounter(name: String)

Decreases the current count for the counter with the supplied name. If no counter with this name exists or this operation would decrease the corresponding counter below 0 (would get negative), an appropriate exception will be thrown.

incrementCounter

abstract suspend fun incrementCounter(name: String)

Increases the current count for the counter with the supplied name. If no counter with this name exists or this operation would increase the corresponding counter above the current capacity, an appropriate exception will be thrown.

listCapacity

abstract suspend fun listCapacity(name: String): Long

Retrieves the current capacity of the list with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no list with this name exists, an appropriate exception will be thrown.

abstract suspend fun listCapacity(name: String, capacity: Long)

Sets a new capacity for the list with the supplied name. If no list with this name exists or the capacity is not in the interval [0, 1000], an appropriate exception will be thrown.

listContains

abstract suspend fun listContains(name: String, value: String): Boolean

Checks whether the specified value is within the list with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no list with this name exists, an appropriate exception will be thrown.

listSize

abstract suspend fun listSize(name: String): Int

Retrieves the current size of the list with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no list with this name exists, an appropriate exception will be thrown.

listValues

abstract suspend fun listValues(name: String): List<String>

Retrieves the current entries of the list with the supplied name. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource. If no list with this name exists, an appropriate exception will be thrown.

removeListValue

abstract suspend fun removeListValue(name: String, value: String)

Removes the supplied value from the list with the supplied name. If no list with this name exists or the specified entry does not exist, an appropriate exception will be thrown.