orbit-client

alltypes

abstract class AbstractActor : AbstractAddressable

AbstractActor()

abstract class AbstractAddressable

AbstractAddressable()
lateinit var context: AddressableContext

@NonConcrete interface Actor : Addressable
class ActorProxyFactory

fun <T : ActorWithNoKey> createProxy(grainType: Class<T>): T
fun <T : ActorWithStringKey> createProxy(grainType: Class<T>, key: String): T
fun <T : ActorWithInt32Key> createProxy(grainType: Class<T>, key: Int): T
fun <T : ActorWithInt64Key> createProxy(grainType: Class<T>, key: Long): T

@NonConcrete interface ActorWithInt32Key : Actor
@NonConcrete interface ActorWithInt64Key : Actor
@NonConcrete interface ActorWithNoKey : Actor
@NonConcrete interface ActorWithStringKey : Actor
@NonConcrete interface Addressable
typealias AddressableClass = Class<out Addressable>
interface AddressableConstructor

abstract fun constructAddressable(clazz: Class<out Addressable>): Addressable

data class AddressableContext

AddressableContext(reference: AddressableReference, client: OrbitClient)
val client: OrbitClient
val reference: AddressableReference

enum class ClientState

CONNECTED
CONNECTING
IDLE
STOPPING

enum class DeactivationReason

EXTERNALLY_TRIGGERED
LEASE_RENEWAL_FAILED
NODE_SHUTTING_DOWN
TTL_EXPIRED

class NodeLeaseRenewalFailed : Throwable

NodeLeaseRenewalFailed(msg: String)

interface NodeLeaseRenewalFailedHandler

abstract fun onLeaseRenewalFailed(): Unit

@Target([AnnotationTarget.CLASS]) annotation class NonConcrete

NonConcrete()

@Target([AnnotationTarget.FUNCTION]) annotation class OnActivate

OnActivate()

@Target([AnnotationTarget.FUNCTION]) annotation class OnDeactivate

OnDeactivate()

class OrbitClient

OrbitClient(config: OrbitClientConfig = OrbitClientConfig())
val actorFactory: ActorProxyFactory
val clock: Clock
val config: OrbitClientConfig
fun start(): Job
fun stop(): Job

data class OrbitClientConfig

OrbitClientConfig(grpcEndpoint: String = "dns:///localhost:50056/", namespace: String = "default", tickRate: Duration = Duration.ofSeconds(1), pool: CoroutineDispatcher = Pools.createFixedPool("orbit-client"), railCount: Int = 128, bufferCount: Int = 10_000, packages: List<String> = listOf(), messageTimeout: Duration = Duration.ofSeconds(10), deactivationTimeout: Duration = Duration.ofSeconds(10), addressableTTL: Duration = Duration.ofMinutes(10), addressableConstructor: ExternallyConfigured<AddressableConstructor> = DefaultAddressableConstructor.DefaultAddressableConstructorSingleton, networkRetryAttempts: Int = 5, joinClusterTimeout: Duration = Duration.ofSeconds(30), nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler> = RestartOnNodeRenewalFailure.RestartOnNodeRenewalFailureSingleton)
val addressableConstructor: ExternallyConfigured<AddressableConstructor>
val addressableTTL: Duration
val bufferCount: Int
val deactivationTimeout: Duration
val grpcEndpoint: String
val joinClusterTimeout: Duration
val messageTimeout: Duration
val namespace: String
val networkRetryAttempts: Int
val nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler>
val packages: List<String>
val pool: CoroutineDispatcher
val railCount: Int
val tickRate: Duration

class RemoteException : Exception

RemoteException(msg: String)

class RestartOnNodeRenewalFailure : NodeLeaseRenewalFailedHandler

RestartOnNodeRenewalFailure(orbitClient: OrbitClient, supervisorScope: SupervisorScope)
val logger: KLogger
fun onLeaseRenewalFailed(): Unit
object RestartOnNodeRenewalFailureSingleton : ExternallyConfigured<NodeLeaseRenewalFailedHandler>

val instanceType: Class<RestartOnNodeRenewalFailure>

class TimeoutException : Exception

TimeoutException(msg: String)

package orbit.client

class OrbitClient

OrbitClient(config: OrbitClientConfig = OrbitClientConfig())
val actorFactory: ActorProxyFactory
val clock: Clock
val config: OrbitClientConfig
fun start(): Job
fun stop(): Job

data class OrbitClientConfig

OrbitClientConfig(grpcEndpoint: String = "dns:///localhost:50056/", namespace: String = "default", tickRate: Duration = Duration.ofSeconds(1), pool: CoroutineDispatcher = Pools.createFixedPool("orbit-client"), railCount: Int = 128, bufferCount: Int = 10_000, packages: List<String> = listOf(), messageTimeout: Duration = Duration.ofSeconds(10), deactivationTimeout: Duration = Duration.ofSeconds(10), addressableTTL: Duration = Duration.ofMinutes(10), addressableConstructor: ExternallyConfigured<AddressableConstructor> = DefaultAddressableConstructor.DefaultAddressableConstructorSingleton, networkRetryAttempts: Int = 5, joinClusterTimeout: Duration = Duration.ofSeconds(30), nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler> = RestartOnNodeRenewalFailure.RestartOnNodeRenewalFailureSingleton)
val addressableConstructor: ExternallyConfigured<AddressableConstructor>
val addressableTTL: Duration
val bufferCount: Int
val deactivationTimeout: Duration
val grpcEndpoint: String
val joinClusterTimeout: Duration
val messageTimeout: Duration
val namespace: String
val networkRetryAttempts: Int
val nodeLeaseRenewalFailedHandler: ExternallyConfigured<NodeLeaseRenewalFailedHandler>
val packages: List<String>
val pool: CoroutineDispatcher
val railCount: Int
val tickRate: Duration

package orbit.client.actor

abstract class AbstractActor : AbstractAddressable

AbstractActor()

@NonConcrete interface Actor : Addressable
class ActorProxyFactory

fun <T : ActorWithNoKey> createProxy(grainType: Class<T>): T
fun <T : ActorWithStringKey> createProxy(grainType: Class<T>, key: String): T
fun <T : ActorWithInt32Key> createProxy(grainType: Class<T>, key: Int): T
fun <T : ActorWithInt64Key> createProxy(grainType: Class<T>, key: Long): T

@NonConcrete interface ActorWithInt32Key : Actor
@NonConcrete interface ActorWithInt64Key : Actor
@NonConcrete interface ActorWithNoKey : Actor
@NonConcrete interface ActorWithStringKey : Actor
fun <reified T : ActorWithNoKey> ActorProxyFactory.createProxy(): T
fun <reified T : ActorWithStringKey> ActorProxyFactory.createProxy(key: String): T
fun <reified T : ActorWithInt32Key> ActorProxyFactory.createProxy(key: Int): T
fun <reified T : ActorWithInt64Key> ActorProxyFactory.createProxy(key: Long): T

package orbit.client.addressable

abstract class AbstractAddressable

AbstractAddressable()
lateinit var context: AddressableContext

@NonConcrete interface Addressable
typealias AddressableClass = Class<out Addressable>
interface AddressableConstructor

abstract fun constructAddressable(clazz: Class<out Addressable>): Addressable

data class AddressableContext

AddressableContext(reference: AddressableReference, client: OrbitClient)
val client: OrbitClient
val reference: AddressableReference

enum class DeactivationReason

EXTERNALLY_TRIGGERED
LEASE_RENEWAL_FAILED
NODE_SHUTTING_DOWN
TTL_EXPIRED

@Target([AnnotationTarget.CLASS]) annotation class NonConcrete

NonConcrete()

@Target([AnnotationTarget.FUNCTION]) annotation class OnActivate

OnActivate()

@Target([AnnotationTarget.FUNCTION]) annotation class OnDeactivate

OnDeactivate()

package orbit.client.execution
package orbit.client.mesh

class NodeLeaseRenewalFailed : Throwable

NodeLeaseRenewalFailed(msg: String)

interface NodeLeaseRenewalFailedHandler

abstract fun onLeaseRenewalFailed(): Unit

class RestartOnNodeRenewalFailure : NodeLeaseRenewalFailedHandler

RestartOnNodeRenewalFailure(orbitClient: OrbitClient, supervisorScope: SupervisorScope)
val logger: KLogger
fun onLeaseRenewalFailed(): Unit
object RestartOnNodeRenewalFailureSingleton : ExternallyConfigured<NodeLeaseRenewalFailedHandler>

val instanceType: Class<RestartOnNodeRenewalFailure>

package orbit.client.net

enum class ClientState

CONNECTED
CONNECTING
IDLE
STOPPING

package orbit.client.serializer
package orbit.client.util

class RemoteException : Exception

RemoteException(msg: String)

class TimeoutException : Exception

TimeoutException(msg: String)