Module Contents

Module Contents

Module Contents

interface AddressableDirectory : AsyncMap<AddressableReference, AddressableLease>,

Module Contents

open suspend fun tick():

class AddressableManagementService : AddressableManagementImplBase

Module Contents

AddressableManagementService(addressableManager:

AddressableManager

,

runtimeScopes

:

)

suspend fun abandonLease(request: AbandonAddressableLeaseRequestProto): AbandonAddressableLeaseResponseProto

suspend fun renewLease(request: RenewAddressableLeaseRequestProto): RenewAddressableLeaseResponseProto

class AddressableManager

Module Contents

AddressableManager(addressableDirectory:

AddressableDirectory

,

clusterManager

:

,

config

:

OrbitServerConfig

)

suspend fun abandonLease(key: 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:

val nodeId: NodeId

class AuthStep :

Module Contents

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class AuthSystem

Module Contents

suspend fun auth():

?

suspend fun auth(nodeId: NodeId?):

?

class BlankStep :

Module Contents

class ClientConnection :

Module Contents

ClientConnection(authInfo:

,

incomingChannel

:

ReceiveChannel

<

MessageProto

>

,

outgoingChannel

:

SendChannel

<

MessageProto

>

,

pipeline

:

)

fun close(cause:

?

=

,

messageId

:

?

=

)

:

suspend fun consumeMessages():

fun offerMessage(message: Message):

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

class ClusterManager

Module Contents

ClusterManager(config:

OrbitServerConfig

,

nodeDirectory

:

)

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

<

NodeId

>

fun getAllNodes():

<

NodeInfo

>

suspend fun getNode(nodeId: NodeId, forceRefresh:

=

)

:

NodeInfo

?

suspend fun joinCluster(namespace:

,

capabilities

:

NodeCapabilities

,

url

:

?

=

,

nodeStatus

:

NodeStatus

)

:

NodeInfo

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

suspend fun tick():

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:

ConnectionManager

,

runtimeScopes

:

)

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

class EchoStep :

Module Contents

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class GrpcEndpoint

Module Contents

GrpcEndpoint(serverAuthInterceptor:

ServerAuthInterceptor

,

healthService

:

,

nodeManagementService

:

NodeManagementService

,

addressableManagementService

:

AddressableManagementService

,

connectionService

:

ConnectionService

,

localServerInfo

:

LocalServerInfo

)

interface HealthCheck

Module Contents

abstract suspend fun isHealthy():

class HealthCheckList

Module Contents

HealthCheckList(localNodeInfo:

,

addressableDirectory

:

AddressableDirectory

)

<

>

fun getChecks():

<

>

class HealthService : HealthImplBase

Module Contents

HealthService(checks:

HealthCheckList

)

suspend fun check(request: HealthCheckRequest): HealthCheckResponse

suspend fun isHealthy():

fun watch(request: HealthCheckRequest): ReceiveChannel<HealthCheckResponse>

class IdentityStep :

Module Contents

IdentityStep(localNodeInfo:

)

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

data class LeaseDuration

Module Contents

LeaseDuration(expiresIn: Duration, renewIn: Duration)

val expiresIn: Duration

val renewIn: Duration

class LocalAddressableDirectory : HashMapBackedAsyncMap<AddressableReference, AddressableLease>,

AddressableDirectory

Module Contents

LocalAddressableDirectory()

suspend fun isHealthy():

object LocalAddressableDirectorySingleton : ExternallyConfigured<

AddressableDirectory

>

Module Contents

val instanceType:

<

LocalAddressableDirectory

>

suspend fun tick():

class LocalNodeDirectory : HashMapBackedAsyncMap<NodeId, NodeInfo>,

Module Contents

LocalNodeDirectory()

object LocalNodeDirectorySingleton : ExternallyConfigured<

>

Module Contents

val instanceType:

<

LocalNodeDirectory

>

suspend fun tick():

class LocalNodeInfo :

Module Contents

LocalNodeInfo(clusterManager:

,

serverInfo

:

LocalServerInfo

)

val info: NodeInfo

suspend fun isHealthy():

suspend fun join():

suspend fun start():

suspend fun tick():

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

data class LocalServerInfo

Module Contents

LocalServerInfo(port:

,

url

:

)

class MessageContainer

Module Contents

MessageContainer(message: Message, metadata:

MessageMetadata

)

val message: Message

MessageMetadata

enum class MessageDirection

Module Contents

data class MessageMetadata

Module Contents

MessageMetadata(authInfo:

,

messageDirection

:

MessageDirection

,

respondOnError

:

=

)

val messageDirection:

MessageDirection

val respondOnError:

interface MessageSender

Module Contents

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

interface NodeDirectory : AsyncMap<NodeId, NodeInfo>

Module Contents

open suspend fun tick():

class NodeManagementService : NodeManagementImplBase

Module Contents

NodeManagementService(clusterManager:

,

runtimeScopes

:

)

suspend fun joinCluster(request: JoinClusterRequestProto): NodeLeaseResponseProto

suspend fun renewLease(request: RenewNodeLeaseRequestProto): NodeLeaseResponseProto

class OrbitServer

Module Contents

OrbitServer(config:

OrbitServerConfig

)

fun start(): Job

fun stop(): Job

data class OrbitServerConfig

Module Contents

OrbitServerConfig(serverInfo:

LocalServerInfo

=

,

tickRate

:

Duration

=

,

pipelineRailCount

:

=

,

pipelineBufferCount

:

=

,

nodeLeaseDuration

:

=

,

addressableLeaseDuration

:

=

,

cpuPool

:

CoroutineDispatcher

=

,

ioPool

:

CoroutineDispatcher

=

,

acquireShutdownLatch

:

=

,

nodeDirectory

:

ExternallyConfigured

<

>

=

,

addressableDirectory

:

ExternallyConfigured

<

AddressableDirectory

>

=

)

val acquireShutdownLatch:

val addressableDirectory: ExternallyConfigured<

AddressableDirectory

>

val addressableLeaseDuration:

val cpuPool: CoroutineDispatcher

val ioPool: CoroutineDispatcher

val nodeDirectory: ExternallyConfigured<

>

val nodeLeaseDuration:

val pipelineBufferCount:

val pipelineRailCount:

val serverInfo:

LocalServerInfo

val tickRate: Duration

Module Contents

Pipeline(config:

OrbitServerConfig

,

runtimeScopes

:

,

pipelineSteps

:

,

localNodeInfo

:

)

fun pushMessage(msg: Message, meta:

MessageMetadata

?

=

)

:

class PipelineContext

Module Contents

PipelineContext(pipelineSteps:

<

>

,

pipeline

:

,

metadata

:

MessageMetadata

)

MessageMetadata

suspend fun next(msg: Message):

fun pushNew(msg: Message, newMeta:

MessageMetadata

?

=

)

:

class PipelineException :

Module Contents

PipelineException(lastMsgState: Message, reason:

)

val lastMsgState: Message

interface PipelineStep

Module Contents

open suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

open suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

class PipelineSteps

Module Contents

PipelineSteps(identityStep:

,

placementStep

:

,

verifyStep

:

,

routingStep

:

,

authStep

:

,

transportStep

:

)

<

>

class PlacementStep :

Module Contents

PlacementStep(addressableManager:

AddressableManager

,

localNodeInfo

:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class RemoteMeshNodeConnection :

Module Contents

RemoteMeshNodeConnection(localNode:

,

remoteNode

:

NodeInfo

)

RemoteMeshNodeConnection(localNode:

,

id

:

NodeId

,

channel

:

ManagedChannel

)

fun disconnect():

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

class RemoteMeshNodeManager

Module Contents

RemoteMeshNodeManager(localNode:

,

clusterManager

:

)

fun getNode(nodeId: NodeId):

RemoteMeshNodeConnection

?

suspend fun refreshConnections():

suspend fun tick():

Module Contents

Router(localNode:

,

clusterManager

:

)

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

class RoutingStep :

Module Contents

RoutingStep(router:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

data class RuntimePools

Module Contents

RuntimePools(cpuPool: CoroutineDispatcher, ioPool: CoroutineDispatcher)

val cpuPool: CoroutineDispatcher

val ioPool: CoroutineDispatcher

class RuntimeScopes

Module Contents

RuntimeScopes(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 :

Module Contents

TransportStep(connectionManager:

ConnectionManager

,

remoteMeshNodeManager

:

RemoteMeshNodeManager

)

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

class VerifyStep :

Module Contents

VerifyStep(clusterManager:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

package orbit.server

Module Contents

class OrbitServer

Module Contents

OrbitServer(config:

OrbitServerConfig

)

fun start(): Job

fun stop(): Job

data class OrbitServerConfig

Module Contents

OrbitServerConfig(serverInfo:

LocalServerInfo

=

,

tickRate

:

Duration

=

,

pipelineRailCount

:

=

,

pipelineBufferCount

:

=

,

nodeLeaseDuration

:

=

,

addressableLeaseDuration

:

=

,

cpuPool

:

CoroutineDispatcher

=

,

ioPool

:

CoroutineDispatcher

=

,

acquireShutdownLatch

:

=

,

nodeDirectory

:

ExternallyConfigured

<

>

=

,

addressableDirectory

:

ExternallyConfigured

<

AddressableDirectory

>

=

)

val acquireShutdownLatch:

val addressableDirectory: ExternallyConfigured<

AddressableDirectory

>

val addressableLeaseDuration:

val cpuPool: CoroutineDispatcher

val ioPool: CoroutineDispatcher

val nodeDirectory: ExternallyConfigured<

>

val nodeLeaseDuration:

val pipelineBufferCount:

val pipelineRailCount:

val serverInfo:

LocalServerInfo

val tickRate: Duration

package orbit.server.auth

Module Contents

data class AuthInfo

Module Contents

AuthInfo(isManagementNode:

,

nodeId

:

NodeId

)

val isManagementNode:

val nodeId: NodeId

class AuthSystem

Module Contents

suspend fun auth():

?

suspend fun auth(nodeId: NodeId?):

?

package orbit.server.concurrent

Module Contents

data class RuntimePools

Module Contents

RuntimePools(cpuPool: CoroutineDispatcher, ioPool: CoroutineDispatcher)

val cpuPool: CoroutineDispatcher

val ioPool: CoroutineDispatcher

class RuntimeScopes

Module Contents

RuntimeScopes(runtimePools:

,

exceptionHandler

:

(

CoroutineContext

,

)

->

)

val cpuScope: CoroutineScope

val ioScope: CoroutineScope

package orbit.server.mesh

Module Contents

interface AddressableDirectory : AsyncMap<AddressableReference, AddressableLease>,

Module Contents

open suspend fun tick():

class AddressableManager

Module Contents

AddressableManager(addressableDirectory:

AddressableDirectory

,

clusterManager

:

,

config

:

OrbitServerConfig

)

suspend fun abandonLease(key: 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:

OrbitServerConfig

,

nodeDirectory

:

)

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

<

NodeId

>

fun getAllNodes():

<

NodeInfo

>

suspend fun getNode(nodeId: NodeId, forceRefresh:

=

)

:

NodeInfo

?

suspend fun joinCluster(namespace:

,

capabilities

:

NodeCapabilities

,

url

:

?

=

,

nodeStatus

:

NodeStatus

)

:

NodeInfo

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

suspend fun tick():

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

data class LeaseDuration

Module Contents

LeaseDuration(expiresIn: Duration, renewIn: Duration)

val expiresIn: Duration

val renewIn: Duration

class LocalNodeInfo :

Module Contents

LocalNodeInfo(clusterManager:

,

serverInfo

:

LocalServerInfo

)

val info: NodeInfo

suspend fun isHealthy():

suspend fun join():

suspend fun start():

suspend fun tick():

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

open suspend fun tick():

package orbit.server.mesh.local

Module Contents

class LocalAddressableDirectory : HashMapBackedAsyncMap<AddressableReference, AddressableLease>,

AddressableDirectory

Module Contents

LocalAddressableDirectory()

suspend fun isHealthy():

object LocalAddressableDirectorySingleton : ExternallyConfigured<

AddressableDirectory

>

Module Contents

val instanceType:

<

LocalAddressableDirectory

>

suspend fun tick():

class LocalNodeDirectory : HashMapBackedAsyncMap<NodeId, NodeInfo>,

Module Contents

LocalNodeDirectory()

object LocalNodeDirectorySingleton : ExternallyConfigured<

>

Module Contents

val instanceType:

<

LocalNodeDirectory

>

suspend fun tick():

package orbit.server.net

Module Contents

class ClientConnection :

Module Contents

ClientConnection(authInfo:

,

incomingChannel

:

ReceiveChannel

<

MessageProto

>

,

outgoingChannel

:

SendChannel

<

MessageProto

>

,

pipeline

:

)

fun close(cause:

?

=

,

messageId

:

?

=

)

:

suspend fun consumeMessages():

fun offerMessage(message: Message):

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

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 MessageContainer

Module Contents

MessageContainer(message: Message, metadata:

MessageMetadata

)

val message: Message

MessageMetadata

enum class MessageDirection

Module Contents

data class MessageMetadata

Module Contents

MessageMetadata(authInfo:

,

messageDirection

:

MessageDirection

,

respondOnError

:

=

)

val messageDirection:

MessageDirection

val respondOnError:

interface MessageSender

Module Contents

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

class RemoteMeshNodeConnection :

Module Contents

RemoteMeshNodeConnection(localNode:

,

remoteNode

:

NodeInfo

)

RemoteMeshNodeConnection(localNode:

,

id

:

NodeId

,

channel

:

ManagedChannel

)

fun disconnect():

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

class RemoteMeshNodeManager

Module Contents

RemoteMeshNodeManager(localNode:

,

clusterManager

:

)

fun getNode(nodeId: NodeId):

RemoteMeshNodeConnection

?

suspend fun refreshConnections():

suspend fun tick():

package orbit.server.pipeline

Module Contents

Module Contents

Pipeline(config:

OrbitServerConfig

,

runtimeScopes

:

,

pipelineSteps

:

,

localNodeInfo

:

)

fun pushMessage(msg: Message, meta:

MessageMetadata

?

=

)

:

class PipelineContext

Module Contents

PipelineContext(pipelineSteps:

<

>

,

pipeline

:

,

metadata

:

MessageMetadata

)

MessageMetadata

suspend fun next(msg: Message):

fun pushNew(msg: Message, newMeta:

MessageMetadata

?

=

)

:

class PipelineException :

Module Contents

PipelineException(lastMsgState: Message, reason:

)

val lastMsgState: Message

class PipelineSteps

Module Contents

PipelineSteps(identityStep:

,

placementStep

:

,

verifyStep

:

,

routingStep

:

,

authStep

:

,

transportStep

:

)

<

>

package orbit.server.pipeline.step

Module Contents

class AuthStep :

Module Contents

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class BlankStep :

Module Contents

class EchoStep :

Module Contents

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class IdentityStep :

Module Contents

IdentityStep(localNodeInfo:

)

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

interface PipelineStep

Module Contents

open suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

open suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

class PlacementStep :

Module Contents

PlacementStep(addressableManager:

AddressableManager

,

localNodeInfo

:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

class RoutingStep :

Module Contents

RoutingStep(router:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

class TransportStep :

Module Contents

TransportStep(connectionManager:

ConnectionManager

,

remoteMeshNodeManager

:

RemoteMeshNodeManager

)

suspend fun onOutbound(context:

PipelineContext

,

msg

:

Message

)

:

class VerifyStep :

Module Contents

VerifyStep(clusterManager:

)

suspend fun onInbound(context:

PipelineContext

,

msg

:

Message

)

:

package orbit.server.router

Module Contents

Module Contents

Router(localNode:

,

clusterManager

:

)

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

package orbit.server.service

Module Contents

class AddressableManagementService : AddressableManagementImplBase

Module Contents

AddressableManagementService(addressableManager:

AddressableManager

,

runtimeScopes

:

)

suspend fun abandonLease(request: AbandonAddressableLeaseRequestProto): AbandonAddressableLeaseResponseProto

suspend fun renewLease(request: RenewAddressableLeaseRequestProto): RenewAddressableLeaseResponseProto

class ConnectionService : ConnectionImplBase

Module Contents

ConnectionService(connectionManager:

ConnectionManager

,

runtimeScopes

:

)

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

class GrpcEndpoint

Module Contents

GrpcEndpoint(serverAuthInterceptor:

ServerAuthInterceptor

,

healthService

:

,

nodeManagementService

:

NodeManagementService

,

addressableManagementService

:

AddressableManagementService

,

connectionService

:

ConnectionService

,

localServerInfo

:

LocalServerInfo

)

interface HealthCheck

Module Contents

abstract suspend fun isHealthy():

class HealthCheckList

Module Contents

HealthCheckList(localNodeInfo:

,

addressableDirectory

:

AddressableDirectory

)

<

>

fun getChecks():

<

>

class HealthService : HealthImplBase

Module Contents

HealthService(checks:

HealthCheckList

)

suspend fun check(request: HealthCheckRequest): HealthCheckResponse

suspend fun isHealthy():

fun watch(request: HealthCheckRequest): ReceiveChannel<HealthCheckResponse>

class NodeManagementService : NodeManagementImplBase

Module Contents

NodeManagementService(clusterManager:

,

runtimeScopes

:

)

suspend fun joinCluster(request: JoinClusterRequestProto): 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<

!

>