orbit.shared.exception.Exception.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of orbit-shared 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.shared.exception

import orbit.shared.mesh.ChallengeToken
import orbit.shared.mesh.NodeId
import orbit.shared.net.MessageContent

/**
 * An exception of this type is thrown when a node id is invalid.
 */
class InvalidNodeId(nodeId: NodeId) : Throwable("$nodeId is not valid. Did the lease expire?")

/**
 * An exception of this type is thrown when a lease renewal failed due to an invalid challenge token.
 */
@Suppress("UNUSED_PARAMETER")
class InvalidChallengeException(nodeId: NodeId, challengeToken: ChallengeToken) :
    Throwable("Invalid challenge for $nodeId")

/**
 * An exception of this type is thrown when an internal capacity in Orbit is exceeded.
 */
class CapacityExceededException(message: String) : Throwable(message)

/**
 * An exception of this type is thrown when authentication fails.
 */
class AuthFailed(message: String) : Throwable(message)

/**
 * An exception of this type is thrown when authentication fails.
 */
class PlacementFailedException(message: String) : Throwable(message)

/**
 * An exception fo this type is thrown when a message needs to be routed to a new node
 */
class RerouteMessageException(message: String) : Throwable(message)

fun Throwable?.toErrorContent(): MessageContent.Error = MessageContent.Error(
    description = this?.toString()
)