orbit.client.addressable.Addressable.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of orbit-client Show documentation

Orbit is a system to make building highly scalable realtime services easier.

There is a newer version: 2.0.0a19

/*
 Copyright (C) 2015 - 2019 Electronic Arts Inc.  All rights reserved.
 This file is part of the Orbit Project .
 See license in LICENSE.
 */

package orbit.client.addressable

import orbit.client.OrbitClient
import orbit.shared.addressable.AddressableReference


/**
 * Denotes an addressable that does not have a concrete implementation.
 */
@MustBeDocumented
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.CLASS)
annotation class NonConcrete

/**
 * Marker interface that determines an interface is addressable remotely.
 */
@NonConcrete
interface Addressable

/**
 * A class type which extends [Addressable].
 */
typealias AddressableClass = Class

/**
 * Denotes a method which is executed on activation for lifecycle managed [Addressable]s.
 */
@MustBeDocumented
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class OnActivate

/**
 * Denotes a method which is executed on deactivation for lifecycle managed [Addressable]s.
 */
@MustBeDocumented
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class OnDeactivate

/**
 * Denotes the reason an addressable is deactivating.
 */
enum class DeactivationReason {
    /**
     * The Addressable TTL expired normally.
     */
    TTL_EXPIRED,
    /**
     * The node is shutting down.
     */
    NODE_SHUTTING_DOWN,
    /**
     * The addressable's lease renewal failed.
     */
    LEASE_RENEWAL_FAILED,
    /**
     * The deactivation was triggered by another subsystem.
     */
    EXTERNALLY_TRIGGERED
}

/**
 * An abstract [Addressable] which allows Orbit to provide an [AddressableContext].
 */
abstract class AbstractAddressable {
    /**
     * The Orbit context. It will be available after the [Addressable] is registered with Orbit.
     * Attempting to access this variable before registration is undefined behavior.
     */
    lateinit var context: AddressableContext
}

/**
 * A context available to an [Addressable] which gives access to Orbit runtime information.
 */
data class AddressableContext(
    /**
     * A reference to this [Addressable].
     */
    val reference: AddressableReference,
    /**
     * A reference to the [OrbitClient].
     */
    val client: OrbitClient
)