Module Contents

open suspend fun count():

Module Contents

class AddressableManagementService : AddressableManagementImplBase

Module Contents

AddressableManagementService(addressableManager:

runtimeScopes

suspend fun abandonLease(request: AbandonAddressableLeaseRequestProto): AbandonAddressableLeaseResponseProto

)

suspend fun renewLease(request: RenewAddressableLeaseRequestProto): RenewAddressableLeaseResponseProto

class AddressableManager

Module Contents

AddressableManager(addressableDirectory:

clusterManager

clock

Clock

config

suspend fun abandonLease(addressableReference: AddressableReference, nodeId: NodeId):

)

suspend fun locateOrPlace(namespace: Namespace, addressableReference: AddressableReference): NodeId

suspend fun renewLease(addressableReference: AddressableReference, nodeId: NodeId): AddressableLease

data class AuthInfo

Module Contents

AuthInfo(isManagementNode:

nodeId

NodeId

)

val isManagementNode:

Module Contents

suspend fun auth(nodeId: NodeId?):

msg

Message

)

Module Contents

Module Contents

class ClientConnection :

ClientConnection(authInfo:

Module Contents

AuthInfo

incomingChannel

ReceiveChannel

MessageProto

outgoingChannel

SendChannel

MessageProto

pipeline

)

messageId

)

suspend fun consumeMessages():

fun offerMessage(message: Message):

suspend fun sendMessage(message: Message, route: Route?):

class ClusterManager

Module Contents

ClusterManager(config:

clock

Clock

nodeDirectory

fun findRoute(sourceNode: NodeId, targetNode: NodeId):

)

List

NodeId

fun getAllNodes():

Collection

NodeInfo

suspend fun getNode(nodeId: NodeId, forceRefresh:

suspend fun joinCluster(namespace:

)

NodeInfo

capabilities

NodeCapabilities

url

suspend fun renewLease(nodeId: NodeId, challengeToken: ChallengeToken, capabilities: NodeCapabilities): NodeInfo

nodeStatus

NodeStatus

)

NodeInfo

suspend fun updateNode(nodeId: NodeId, body: (NodeInfo?) -> NodeInfo?): NodeInfo?

class ConnectionManager

Module Contents

ConnectionManager(runtimeScopes:

clusterManager

localNodeInfo

authSystem

container

ComponentContainer

)

fun getClient(nodeId: NodeId):

ClientConnection

fun onNewClient(nodeId: NodeId, incomingChannel: ReceiveChannel<MessageProto>, outgoingChannel: SendChannel<MessageProto>):

class ConnectionService : ConnectionImplBase

Module Contents

ConnectionService(connectionManager:

runtimeScopes

fun openStream(requests: ReceiveChannel<MessageProto>): ReceiveChannel<MessageProto>

)

class EchoStep :

Module Contents

EchoStep()

msg

Message

)

GrpcEndpoint(serverAuthInterceptor:

class GrpcEndpoint

Module Contents

ServerAuthInterceptor

healthService

HealthService

nodeManagementService

NodeManagementService

addressableManagementService

AddressableManagementService

connectionService

localServerInfo

)

interface HealthCheck

Module Contents

abstract suspend fun isHealthy():

HealthCheckList(localNodeInfo:

class HealthCheckList

Module Contents

addressableDirectory

)

class HealthService : HealthImplBase

Module Contents

HealthService(checks:

HealthCheckList

runtimeScopes

suspend fun check(request: HealthCheckRequest): HealthCheckResponse

)

class IdentityStep :

IdentityStep(localNodeInfo:

Module Contents

)

msg

Message

)

LeaseDuration(leaseDuration:

data class LeaseDuration

Module Contents

)

val expiresIn: Duration

val leaseDuration:

class LocalAddressableDirectory : HashMapBackedAsyncMap<NamespacedAddressableReference, AddressableLease>,

val renewIn: Duration

LocalAddressableDirectory(clock: Clock)

Module Contents

object LocalAddressableDirectorySingleton : ExternallyConfigured<

Module Contents

LocalAddressableDirectory

val map:

ConcurrentHashMap

NamespacedAddressableReference

AddressableLease

class LocalMeterRegistry : SimpleMeterRegistry

Module Contents

LocalMeterRegistry()

object LocalMeterRegistrySingleton : ExternallyConfigured<MeterRegistry>

Module Contents

class LocalNodeDirectory : HashMapBackedAsyncMap<NodeId, NodeInfo>,

LocalMeterRegistry

LocalNodeDirectory(clock: Clock)

Module Contents

fun clear():

object LocalNodeDirectorySingleton : ExternallyConfigured<

Module Contents

NodeId

NodeInfo

class LocalNodeInfo :

LocalNodeInfo(clusterManager:

Module Contents

clock

Clock

serverInfo

)

val info: NodeInfo

suspend fun updateInfo(body: (NodeInfo) -> NodeInfo):

data class LocalServerInfo

Module Contents

LocalServerInfo(port:

url

)

class MessageContainer

Module Contents

MessageContainer(message: Message, metadata:

)

enum class MessageDirection

Module Contents

INBOUND

OUTBOUND

data class MessageMetadata

Module Contents

MessageMetadata(authInfo:

messageDirection

respondOnError

)

val messageDirection:

MessageDirection

val respondOnError:

abstract suspend fun sendMessage(message: Message, route: Route? = null):

interface MessageSender

Module Contents

open class Meters

Module Contents

Meters()

val AddressableCount:

abstract val AddressableCount:

val ConnectedClients:

Module Contents

abstract val ConnectedClients:

abstract val ConnectedNodes:

abstract val HealthCheck:

abstract val MessageSizes:

abstract val NodeCount:

abstract val PassingHealthChecks:

abstract val PlacementTimer:

abstract val SlowTicks:

abstract val TickTimer:

val Names: MeterNames

val NodeCount:

val PlacementTimer_Count:

val PlacementTimer_TotalTime:

interface NodeDirectory : AsyncMap<NodeId, NodeInfo>

Module Contents

class NodeManagementService : NodeManagementImplBase

Module Contents

NodeManagementService(clusterManager:

runtimeScopes

suspend fun joinCluster(request: JoinClusterRequestProto): NodeLeaseResponseProto

)

suspend fun leaveCluster(request: LeaveClusterRequestProto): NodeLeaseResponseProto

suspend fun renewLease(request: RenewNodeLeaseRequestProto): NodeLeaseResponseProto

class OrbitServer

Module Contents

OrbitServer(config:

val nodeStatus: NodeStatus

)

fun start(): Job

fun stop(): Job

data class OrbitServerConfig

Module Contents

OrbitServerConfig(serverInfo:

tickRate

Duration

pipelineRailCount

pipelineBufferCount

clock

Clock

nodeLeaseDuration

addressableLeaseDuration

cpuPool

CoroutineDispatcher

ioPool

CoroutineDispatcher

acquireShutdownLatch

nodeDirectory

ExternallyConfigured

addressableDirectory

ExternallyConfigured

meterRegistry

ExternallyConfigured

MeterRegistry

containerOverrides

ComponentContainerRoot

(

)

val acquireShutdownLatch:

)

val addressableDirectory: ExternallyConfigured<

val addressableLeaseDuration:

val containerOverrides: ComponentContainerRoot.() ->

val clock: Clock

val meterRegistry: ExternallyConfigured<MeterRegistry>

val nodeDirectory: ExternallyConfigured<

val nodeLeaseDuration:

val pipelineBufferCount:

val pipelineRailCount:

val serverInfo:

fun pushMessage(msg: Message, meta:

val tickRate: Duration

Module Contents

runtimeScopes

pipelineSteps

localNodeInfo

)

)

class PipelineContext

Module Contents

PipelineContext(pipelineSteps:

pipeline

metadata

)

suspend fun next(msg: Message):

fun pushNew(msg: Message, newMeta:

MessageMetadata

)

class PipelineException :

PipelineException(lastMsgState: Message, reason:

Module Contents

val lastMsgState: Message

)

val reason:

open suspend fun onInbound(context:

interface PipelineStep

Module Contents

msg

Message

)

open suspend fun onOutbound(context:

msg

Message

)

PipelineSteps(identityStep:

class PipelineSteps

Module Contents

placementStep

verifyStep

routingStep

authStep

transportStep

)

class PlacementStep :

PlacementStep(addressableManager:

Module Contents

localNodeInfo

)

msg

Message

)

class RemoteMeshNodeConnection :

Module Contents

remoteNode

NodeInfo

)

NodeId

channel

ManagedChannel

)

fun disconnect():

suspend fun sendMessage(message: Message, route: Route?):

val id: NodeId

class RemoteMeshNodeManager

Module Contents

RemoteMeshNodeManager(localNode:

clusterManager

fun getNode(nodeId: NodeId):

)

RemoteMeshNodeConnection

suspend fun refreshConnections():

Module Contents

clusterManager

)

fun findRoute(targetNode: NodeId, possibleRoute: Route? = null): Route

Module Contents

)

msg

Message

)

msg

Message

)

RuntimePools(cpuPool: CoroutineDispatcher, ioPool: CoroutineDispatcher)

data class RuntimePools

Module Contents

RuntimeScopes(runtimePools:

class RuntimeScopes

Module Contents

RuntimePools

exceptionHandler

(

CoroutineContext

)

val cpuScope: CoroutineScope

)

val ioScope: CoroutineScope

class ServerAuthInterceptor : ServerInterceptor

Module Contents

ServerAuthInterceptor()

fun <ReqT, RespT> interceptCall(call: ServerCall<ReqT, RespT>?, headers: Metadata, next: ServerCallHandler<ReqT, RespT>): Listener<ReqT>

val NAMESPACE: Key<

val NODE_ID: Key<NodeId!>

val NODE_KEY: Key<

class TransportStep :

TransportStep(connectionManager:

Module Contents

remoteMeshNodeManager

RemoteMeshNodeManager

)

msg

Message

)

class VerifyStep :

VerifyStep(clusterManager:

Module Contents

)

val nodeStatus: NodeStatus

msg

Message

)

Module Contents

Module Contents

)

fun start(): Job

fun stop(): Job

data class OrbitServerConfig

Module Contents

OrbitServerConfig(serverInfo:

tickRate

Duration

pipelineRailCount

pipelineBufferCount

clock

Clock

nodeLeaseDuration

addressableLeaseDuration

cpuPool

CoroutineDispatcher

ioPool

CoroutineDispatcher

acquireShutdownLatch

nodeDirectory

ExternallyConfigured

addressableDirectory

ExternallyConfigured

meterRegistry

ExternallyConfigured

MeterRegistry

containerOverrides

ComponentContainerRoot

(

)

val acquireShutdownLatch:

)

val addressableDirectory: ExternallyConfigured<

val addressableLeaseDuration:

val containerOverrides: ComponentContainerRoot.() ->

val clock: Clock

val meterRegistry: ExternallyConfigured<MeterRegistry>

val nodeDirectory: ExternallyConfigured<

val nodeLeaseDuration:

val pipelineBufferCount:

val pipelineRailCount:

val serverInfo:

package orbit.server.auth

val tickRate: Duration

Module Contents

data class AuthInfo

Module Contents

AuthInfo(isManagementNode:

suspend fun auth(nodeId: NodeId?):

nodeId

NodeId

)

val isManagementNode:

Module Contents

AuthInfo

package orbit.server.concurrent

Module Contents

data class RuntimePools

Module Contents

RuntimePools(cpuPool: CoroutineDispatcher, ioPool: CoroutineDispatcher)

RuntimeScopes(runtimePools:

class RuntimeScopes

Module Contents

RuntimePools

exceptionHandler

(

CoroutineContext

)

val cpuScope: CoroutineScope

)

val ioScope: CoroutineScope

package orbit.server.mesh

Module Contents

interface AddressableDirectory : AsyncMap<NamespacedAddressableReference, AddressableLease>,

open suspend fun count():

Module Contents

AddressableManager(addressableDirectory:

class AddressableManager

Module Contents

clusterManager

clock

Clock

config

suspend fun abandonLease(addressableReference: AddressableReference, nodeId: NodeId):

)

suspend fun locateOrPlace(namespace: Namespace, addressableReference: AddressableReference): NodeId

suspend fun renewLease(addressableReference: AddressableReference, nodeId: NodeId): AddressableLease

class ClusterManager

Module Contents

ClusterManager(config:

clock

Clock

nodeDirectory

fun findRoute(sourceNode: NodeId, targetNode: NodeId):

)

List

NodeId

fun getAllNodes():

Collection

NodeInfo

suspend fun getNode(nodeId: NodeId, forceRefresh:

suspend fun joinCluster(namespace:

)

NodeInfo

capabilities

NodeCapabilities

url

suspend fun renewLease(nodeId: NodeId, challengeToken: ChallengeToken, capabilities: NodeCapabilities): NodeInfo

nodeStatus

NodeStatus

)

NodeInfo

suspend fun updateNode(nodeId: NodeId, body: (NodeInfo?) -> NodeInfo?): NodeInfo?

data class LeaseDuration

Module Contents

LeaseDuration(leaseDuration:

)

val expiresIn: Duration

val leaseDuration:

val renewIn: Duration

class LocalNodeInfo :

LocalNodeInfo(clusterManager:

Module Contents

clock

Clock

serverInfo

)

val info: NodeInfo

suspend fun updateInfo(body: (NodeInfo) -> NodeInfo):

data class LocalServerInfo

Module Contents

LocalServerInfo(port:

url

)

const val MANAGEMENT_NAMESPACE:

interface NodeDirectory : AsyncMap<NodeId, NodeInfo>

Module Contents

package orbit.server.mesh.local

Module Contents

class LocalAddressableDirectory : HashMapBackedAsyncMap<NamespacedAddressableReference, AddressableLease>,

LocalAddressableDirectory(clock: Clock)

Module Contents

object LocalAddressableDirectorySingleton : ExternallyConfigured<

Module Contents

LocalAddressableDirectory

val map:

ConcurrentHashMap

NamespacedAddressableReference

AddressableLease

class LocalMeterRegistry : SimpleMeterRegistry

Module Contents

LocalMeterRegistry()

object LocalMeterRegistrySingleton : ExternallyConfigured<MeterRegistry>

Module Contents

class LocalNodeDirectory : HashMapBackedAsyncMap<NodeId, NodeInfo>,

LocalMeterRegistry

LocalNodeDirectory(clock: Clock)

Module Contents

fun clear():

object LocalNodeDirectorySingleton : ExternallyConfigured<

Module Contents

NodeId

NodeInfo

val logger: KLogger

package orbit.server.net

Module Contents

class ClientConnection :

ClientConnection(authInfo:

Module Contents

AuthInfo

incomingChannel

ReceiveChannel

MessageProto

outgoingChannel

SendChannel

MessageProto

pipeline

)

messageId

)

suspend fun consumeMessages():

fun offerMessage(message: Message):

suspend fun sendMessage(message: Message, route: Route?):

ConnectionManager(runtimeScopes:

class ConnectionManager

Module Contents

clusterManager

localNodeInfo

authSystem

container

ComponentContainer

)

fun getClient(nodeId: NodeId):

ClientConnection

fun onNewClient(nodeId: NodeId, incomingChannel: ReceiveChannel<MessageProto>, outgoingChannel: SendChannel<MessageProto>):

MessageContainer(message: Message, metadata:

class MessageContainer

Module Contents

)

enum class MessageDirection

Module Contents

INBOUND

OUTBOUND

data class MessageMetadata

Module Contents

MessageMetadata(authInfo:

messageDirection

respondOnError

)

val messageDirection:

MessageDirection

val respondOnError:

abstract suspend fun sendMessage(message: Message, route: Route? = null):

interface MessageSender

Module Contents

class RemoteMeshNodeConnection :

Module Contents

remoteNode

NodeInfo

)

NodeId

channel

ManagedChannel

)

fun disconnect():

suspend fun sendMessage(message: Message, route: Route?):

val id: NodeId

class RemoteMeshNodeManager

Module Contents

RemoteMeshNodeManager(localNode:

clusterManager

fun getNode(nodeId: NodeId):

)

RemoteMeshNodeConnection

suspend fun refreshConnections():

package orbit.server.pipeline

Module Contents

Module Contents

runtimeScopes

pipelineSteps

localNodeInfo

)

fun pushMessage(msg: Message, meta:

)

class PipelineContext

Module Contents

PipelineContext(pipelineSteps:

pipeline

metadata

)

suspend fun next(msg: Message):

fun pushNew(msg: Message, newMeta:

MessageMetadata

)

class PipelineException :

PipelineException(lastMsgState: Message, reason:

Module Contents

val lastMsgState: Message

)

val reason:

PipelineSteps(identityStep:

class PipelineSteps

Module Contents

placementStep

verifyStep

routingStep

authStep

transportStep

)

package orbit.server.pipeline.step

Module Contents

class AuthStep :

Module Contents

AuthStep()

msg

Message

)

Module Contents

Module Contents

msg

Message

)

class IdentityStep :

IdentityStep(localNodeInfo:

Module Contents

)

msg

Message

)

open suspend fun onInbound(context:

interface PipelineStep

Module Contents

msg

Message

)

open suspend fun onOutbound(context:

msg

Message

)

class PlacementStep :

PlacementStep(addressableManager:

Module Contents

localNodeInfo

)

msg

Message

)

Module Contents

)

msg

Message

)

msg

Message

)

class TransportStep :

TransportStep(connectionManager:

Module Contents

remoteMeshNodeManager

RemoteMeshNodeManager

)

msg

Message

)

class VerifyStep :

VerifyStep(clusterManager:

Module Contents

)

msg

Message

)

package orbit.server.router

Module Contents

Module Contents

clusterManager

)

fun findRoute(targetNode: NodeId, possibleRoute: Route? = null): Route

package orbit.server.service

Module Contents

class AddressableManagementService : AddressableManagementImplBase

Module Contents

AddressableManagementService(addressableManager:

runtimeScopes

suspend fun abandonLease(request: AbandonAddressableLeaseRequestProto): AbandonAddressableLeaseResponseProto

)

suspend fun renewLease(request: RenewAddressableLeaseRequestProto): RenewAddressableLeaseResponseProto

class ConnectionService : ConnectionImplBase

Module Contents

ConnectionService(connectionManager:

runtimeScopes

fun openStream(requests: ReceiveChannel<MessageProto>): ReceiveChannel<MessageProto>

)

class GrpcEndpoint

Module Contents

GrpcEndpoint(serverAuthInterceptor:

ServerAuthInterceptor

healthService

HealthService

nodeManagementService

NodeManagementService

addressableManagementService

AddressableManagementService

connectionService

localServerInfo

)

interface HealthCheck

Module Contents

abstract suspend fun isHealthy():

HealthCheckList(localNodeInfo:

class HealthCheckList

Module Contents

addressableDirectory

)

class HealthService : HealthImplBase

Module Contents

HealthService(checks:

HealthCheckList

runtimeScopes

suspend fun check(request: HealthCheckRequest): HealthCheckResponse

)

open class Meters

Module Contents

Meters()

val AddressableCount:

abstract val AddressableCount:

val ConnectedClients:

Module Contents

abstract val ConnectedClients:

abstract val ConnectedNodes:

abstract val HealthCheck:

abstract val MessageSizes:

abstract val NodeCount:

abstract val PassingHealthChecks:

abstract val PlacementTimer:

abstract val SlowTicks:

abstract val TickTimer:

val Names: MeterNames

val NodeCount:

val PlacementTimer_Count:

val PlacementTimer_TotalTime:

class NodeManagementService : NodeManagementImplBase

Module Contents

NodeManagementService(clusterManager:

runtimeScopes

suspend fun joinCluster(request: JoinClusterRequestProto): NodeLeaseResponseProto

)

suspend fun leaveCluster(request: LeaveClusterRequestProto): NodeLeaseResponseProto

suspend fun renewLease(request: RenewNodeLeaseRequestProto): NodeLeaseResponseProto

class ServerAuthInterceptor : ServerInterceptor

Module Contents

ServerAuthInterceptor()

fun <ReqT, RespT> interceptCall(call: ServerCall<ReqT, RespT>?, headers: Metadata, next: ServerCallHandler<ReqT, RespT>): Listener<ReqT>

val NAMESPACE: Key<

val NODE_ID: Key<NodeId!>

val NODE_KEY: Key<