RouterFailure

data class RouterFailure @JvmOverloads() constructor(url: URL, routerOrigin: RouterOrigin, message: String, code: Int?, throwable: Throwable?)

Describes a reason for a route request failure.

Parameters

url

original request URL

routerOrigin

router that failed to generate a route

message

message attached to the error code

code

if present, can be either be the HTTP code for offboard requests or an internal error code for onboard requests

throwable

provided if an unexpected exception occurred when creating the request or processing the response

Constructors

RouterFailure

@JvmOverloads()

fun RouterFailure(url: URL, routerOrigin: RouterOrigin, message: String, code: Int? = null, throwable: Throwable? = null)

original request URL

Functions

component1

operator fun component1(): URL

component2

operator fun component2(): RouterOrigin

component3

operator fun component3(): String

component4

operator fun component4(): Int?

component5

operator fun component5(): Throwable?

copy

fun copy(url: URL, routerOrigin: RouterOrigin, message: String, code: Int? = null, throwable: Throwable? = null): RouterFailure

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

code

val code: Int? = null

if present, can be either be the HTTP code for offboard requests or an internal error code for onboard requests

message

val message: String

message attached to the error code

routerOrigin

val routerOrigin: RouterOrigin

router that failed to generate a route

throwable

val throwable: Throwable? = null

provided if an unexpected exception occurred when creating the request or processing the response

url

val url: URL

original request URL