orbit-shared

alltypes

data class AddressableInvocation

AddressableInvocation(reference: AddressableReference, method: String, args: AddressableInvocationArguments)
val args: AddressableInvocationArguments
fun equals(other: Any?): Boolean
fun hashCode(): Int
val method: String
val reference: AddressableReference

typealias AddressableInvocationArgument = Pair<Any?, Class<*>>
typealias AddressableInvocationArguments = Array<out AddressableInvocationArgument>
data class AddressableLease

AddressableLease(nodeId: NodeId, reference: AddressableReference, expiresAt: Timestamp, renewAt: Timestamp)
val expiresAt: Timestamp
val nodeId: NodeId
val reference: AddressableReference
val renewAt: Timestamp

data class AddressableReference

AddressableReference(type: AddressableType, key: Key)
val key: Key
val type: AddressableType

typealias AddressableType = String
class AuthFailed : Throwable

AuthFailed(message: String)

class CapacityExceededException : Throwable

CapacityExceededException(message: String)

typealias ChallengeToken = String
class InvalidChallengeException : Throwable

InvalidChallengeException(nodeId: NodeId, challengeToken: ChallengeToken)

class InvalidNodeId : Throwable

InvalidNodeId(nodeId: NodeId)

sealed class Key

data class Int32Key : Key

Int32Key(key: Int)
val key: Int

data class Int64Key : Key

Int64Key(key: Long)
val key: Long

object NoKey : Key

fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

fun none(): Key
fun of(value: Any): Key
data class StringKey : Key

StringKey(key: String)
val key: String

kotlin.Throwable

fun Throwable?.toErrorContent(): Error

data class Message

Message(content: MessageContent, messageId: Long? = null, source: NodeId? = null, target: MessageTarget? = null)
val content: MessageContent
val messageId: Long?
val source: NodeId?
val target: MessageTarget?

sealed class MessageContent

class ConnectionInfoRequest : MessageContent

ConnectionInfoRequest()

data class ConnectionInfoResponse : MessageContent

ConnectionInfoResponse(nodeId: NodeId)
val nodeId: NodeId

data class Error : MessageContent

Error(description: String?)
val description: String?

data class InvocationRequest : MessageContent

InvocationRequest(destination: AddressableReference, method: String, arguments: String)
val arguments: String
val destination: AddressableReference
val method: String

data class InvocationResponse : MessageContent

InvocationResponse(data: String)
val data: String

sealed class MessageTarget

data class RoutedUnicast : MessageTarget

RoutedUnicast(route: Route)
val route: Route

data class Unicast : MessageTarget

Unicast(targetNode: NodeId)
val targetNode: NodeId

typealias Namespace = String
data class NodeCapabilities

NodeCapabilities(addressableTypes: Iterable<AddressableType> = emptyList())
val addressableTypes: Iterable<AddressableType>

data class NodeId

NodeId(key: NodeKey, namespace: Namespace)
fun generate(namespace: Namespace): NodeId
val key: NodeKey
val namespace: Namespace

data class NodeInfo

NodeInfo(id: NodeId, capabilities: NodeCapabilities, url: String? = null, lease: NodeLease, visibleNodes: Set<NodeId> = emptySet(), nodeStatus: NodeStatus)
val capabilities: NodeCapabilities
val id: NodeId
val lease: NodeLease
val nodeStatus: NodeStatus
val url: String?
val visibleNodes: Set<NodeId>

typealias NodeKey = String
data class NodeLease

NodeLease(challengeToken: ChallengeToken, expiresAt: Timestamp, renewAt: Timestamp)
val challengeToken: ChallengeToken
val expiresAt: Timestamp
val renewAt: Timestamp

enum class NodeStatus

ACTIVE
DRAINING
STARTING
STOPPED

class PlacementFailedException : Throwable

PlacementFailedException(message: String)

data class Route

Route(path: List<NodeId> = emptyList())
val destinationNode: NodeId
val nextNode: NodeId
val path: List<NodeId>
fun pop(): PopResult
data class PopResult

PopResult(route: Route, nodeId: NodeId)
val nodeId: NodeId
val route: Route

fun push(nodeId: NodeId): Route

package orbit.shared.addressable

data class AddressableInvocation

AddressableInvocation(reference: AddressableReference, method: String, args: AddressableInvocationArguments)
val args: AddressableInvocationArguments
fun equals(other: Any?): Boolean
fun hashCode(): Int
val method: String
val reference: AddressableReference

typealias AddressableInvocationArgument = Pair<Any?, Class<*>>
typealias AddressableInvocationArguments = Array<out AddressableInvocationArgument>
data class AddressableLease

AddressableLease(nodeId: NodeId, reference: AddressableReference, expiresAt: Timestamp, renewAt: Timestamp)
val expiresAt: Timestamp
val nodeId: NodeId
val reference: AddressableReference
val renewAt: Timestamp

data class AddressableReference

AddressableReference(type: AddressableType, key: Key)
val key: Key
val type: AddressableType

typealias AddressableType = String
sealed class Key

data class Int32Key : Key

Int32Key(key: Int)
val key: Int

data class Int64Key : Key

Int64Key(key: Long)
val key: Long

object NoKey : Key

fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toString(): String

fun none(): Key
fun of(value: Any): Key
data class StringKey : Key

StringKey(key: String)
val key: String

package orbit.shared.exception

class AuthFailed : Throwable

AuthFailed(message: String)

class CapacityExceededException : Throwable

CapacityExceededException(message: String)

class InvalidChallengeException : Throwable

InvalidChallengeException(nodeId: NodeId, challengeToken: ChallengeToken)

class InvalidNodeId : Throwable

InvalidNodeId(nodeId: NodeId)

kotlin.Throwable

fun Throwable?.toErrorContent(): Error

class PlacementFailedException : Throwable

PlacementFailedException(message: String)

package orbit.shared.mesh

typealias ChallengeToken = String
typealias Namespace = String
data class NodeCapabilities

NodeCapabilities(addressableTypes: Iterable<AddressableType> = emptyList())
val addressableTypes: Iterable<AddressableType>

data class NodeId

NodeId(key: NodeKey, namespace: Namespace)
fun generate(namespace: Namespace): NodeId
val key: NodeKey
val namespace: Namespace

data class NodeInfo

NodeInfo(id: NodeId, capabilities: NodeCapabilities, url: String? = null, lease: NodeLease, visibleNodes: Set<NodeId> = emptySet(), nodeStatus: NodeStatus)
val capabilities: NodeCapabilities
val id: NodeId
val lease: NodeLease
val nodeStatus: NodeStatus
val url: String?
val visibleNodes: Set<NodeId>

typealias NodeKey = String
data class NodeLease

NodeLease(challengeToken: ChallengeToken, expiresAt: Timestamp, renewAt: Timestamp)
val challengeToken: ChallengeToken
val expiresAt: Timestamp
val renewAt: Timestamp

enum class NodeStatus

ACTIVE
DRAINING
STARTING
STOPPED

package orbit.shared.net

data class Message

Message(content: MessageContent, messageId: Long? = null, source: NodeId? = null, target: MessageTarget? = null)
val content: MessageContent
val messageId: Long?
val source: NodeId?
val target: MessageTarget?

sealed class MessageContent

class ConnectionInfoRequest : MessageContent

ConnectionInfoRequest()

data class ConnectionInfoResponse : MessageContent

ConnectionInfoResponse(nodeId: NodeId)
val nodeId: NodeId

data class Error : MessageContent

Error(description: String?)
val description: String?

data class InvocationRequest : MessageContent

InvocationRequest(destination: AddressableReference, method: String, arguments: String)
val arguments: String
val destination: AddressableReference
val method: String

data class InvocationResponse : MessageContent

InvocationResponse(data: String)
val data: String

sealed class MessageTarget

data class RoutedUnicast : MessageTarget

RoutedUnicast(route: Route)
val route: Route

data class Unicast : MessageTarget

Unicast(targetNode: NodeId)
val targetNode: NodeId

package orbit.shared.router

data class Route

Route(path: List<NodeId> = emptyList())
val destinationNode: NodeId
val nextNode: NodeId
val path: List<NodeId>
fun pop(): PopResult
data class PopResult

PopResult(route: Route, nodeId: NodeId)
val nodeId: NodeId
val route: Route

fun push(nodeId: NodeId): Route