Interface GstpErrorDetailsByCode

details by code: the protocol rejections carry only their code; the two wrappers carry the wrapped error's code and message.

interface GstpErrorDetailsByCode {
    SenderMissingEncryptionKey: { code: "SenderMissingEncryptionKey" };
    RecipientMissingEncryptionKey: { code: "RecipientMissingEncryptionKey" };
    SenderMissingVerificationKey: { code: "SenderMissingVerificationKey" };
    ContinuationExpired: { code: "ContinuationExpired" };
    ContinuationIdInvalid: { code: "ContinuationIdInvalid" };
    PeerContinuationNotEncrypted: { code: "PeerContinuationNotEncrypted" };
    MissingPeerContinuation: { code: "MissingPeerContinuation" };
    StateOnFailedResponse: { code: "StateOnFailedResponse" };
    Envelope: {
        code: "Envelope";
        inner: EnvelopeErrorCode | undefined;
        message: string;
    };
    XID: { code: "XID"; inner: XIDErrorCode
    | undefined; message: string };
}

Index

Properties

SenderMissingEncryptionKey RecipientMissingEncryptionKey SenderMissingVerificationKey ContinuationExpired ContinuationIdInvalid PeerContinuationNotEncrypted MissingPeerContinuation StateOnFailedResponse Envelope XID

Properties

SenderMissingEncryptionKey

SenderMissingEncryptionKey: { code: "SenderMissingEncryptionKey" }

The sender's document holds no encryption key.

Type Declaration

Readonlycode: "SenderMissingEncryptionKey"

The discriminant.

RecipientMissingEncryptionKey

RecipientMissingEncryptionKey: { code: "RecipientMissingEncryptionKey" }

A recipient's document holds no encryption key.

Type Declaration

Readonlycode: "RecipientMissingEncryptionKey"

The discriminant.

SenderMissingVerificationKey

SenderMissingVerificationKey: { code: "SenderMissingVerificationKey" }

The sender's document holds no verification key.

Type Declaration

Readonlycode: "SenderMissingVerificationKey"

The discriminant.

ContinuationExpired

ContinuationExpired: { code: "ContinuationExpired" }

The continuation's deadline has passed.

Type Declaration

Readonlycode: "ContinuationExpired"

The discriminant.

ContinuationIdInvalid

ContinuationIdInvalid: { code: "ContinuationIdInvalid" }

The continuation is bound to another request id.

Type Declaration

Readonlycode: "ContinuationIdInvalid"

The discriminant.

PeerContinuationNotEncrypted

PeerContinuationNotEncrypted: { code: "PeerContinuationNotEncrypted" }

The peer's continuation arrived in the clear.

Type Declaration

Readonlycode: "PeerContinuationNotEncrypted"

The discriminant.

MissingPeerContinuation

MissingPeerContinuation: { code: "MissingPeerContinuation" }

A request arrived without the peer's continuation.

Type Declaration

Readonlycode: "MissingPeerContinuation"

The discriminant.

StateOnFailedResponse

StateOnFailedResponse: { code: "StateOnFailedResponse" }

State was set on a response that is not a success.

Type Declaration

Readonlycode: "StateOnFailedResponse"

The discriminant.

Envelope

Envelope: {
    code: "Envelope";
    inner: EnvelopeErrorCode | undefined;
    message: string;
}

An envelope operation failed: inner is the envelope error's code.

Type Declaration

Readonlycode: "Envelope"

The discriminant.
Readonlyinner: EnvelopeErrorCode | undefined

The envelope error's code.
Readonlymessage: string

The envelope error's message.

XID

XID: { code: "XID"; inner: XIDErrorCode | undefined; message: string }

The sender's XID document did not parse: inner is the xid error's code.

Type Declaration

Readonlycode: "XID"

The discriminant.
Readonlyinner: XIDErrorCode | undefined

The xid error's code.
Readonlymessage: string

The xid error's message.

Interface GstpErrorDetailsByCode

Index

Properties

Properties

SenderMissingEncryptionKey

Type Declaration

`Readonly`code: "SenderMissingEncryptionKey"

RecipientMissingEncryptionKey

Type Declaration

`Readonly`code: "RecipientMissingEncryptionKey"

SenderMissingVerificationKey

Type Declaration

`Readonly`code: "SenderMissingVerificationKey"

ContinuationExpired

Type Declaration

`Readonly`code: "ContinuationExpired"

ContinuationIdInvalid

Type Declaration

`Readonly`code: "ContinuationIdInvalid"

PeerContinuationNotEncrypted

Type Declaration

`Readonly`code: "PeerContinuationNotEncrypted"

MissingPeerContinuation

Type Declaration

`Readonly`code: "MissingPeerContinuation"

StateOnFailedResponse

Type Declaration

`Readonly`code: "StateOnFailedResponse"

Envelope

Type Declaration

`Readonly`code: "Envelope"

`Readonly`inner: EnvelopeErrorCode | undefined

`Readonly`message: string

XID

Type Declaration

`Readonly`code: "XID"

`Readonly`inner: XIDErrorCode | undefined

`Readonly`message: string

Settings

On This Page

Interface GstpErrorDetailsByCode

Index

Properties

Properties

SenderMissingEncryptionKey

Type Declaration

Readonlycode: "SenderMissingEncryptionKey"

RecipientMissingEncryptionKey

Type Declaration

Readonlycode: "RecipientMissingEncryptionKey"

SenderMissingVerificationKey

Type Declaration

Readonlycode: "SenderMissingVerificationKey"

ContinuationExpired

Type Declaration

Readonlycode: "ContinuationExpired"

ContinuationIdInvalid

Type Declaration

Readonlycode: "ContinuationIdInvalid"

PeerContinuationNotEncrypted

Type Declaration

Readonlycode: "PeerContinuationNotEncrypted"

MissingPeerContinuation

Type Declaration

Readonlycode: "MissingPeerContinuation"

StateOnFailedResponse

Type Declaration

Readonlycode: "StateOnFailedResponse"

Envelope

Type Declaration

Readonlycode: "Envelope"

Readonlyinner: EnvelopeErrorCode | undefined

Readonlymessage: string

XID

Type Declaration

Readonlycode: "XID"

Readonlyinner: XIDErrorCode | undefined

Readonlymessage: string

Settings

On This Page

`Readonly`code: "SenderMissingEncryptionKey"

`Readonly`code: "RecipientMissingEncryptionKey"

`Readonly`code: "SenderMissingVerificationKey"

`Readonly`code: "ContinuationExpired"

`Readonly`code: "ContinuationIdInvalid"

`Readonly`code: "PeerContinuationNotEncrypted"

`Readonly`code: "MissingPeerContinuation"

`Readonly`code: "StateOnFailedResponse"

`Readonly`code: "Envelope"

`Readonly`inner: EnvelopeErrorCode | undefined

`Readonly`message: string

`Readonly`code: "XID"

`Readonly`inner: XIDErrorCode | undefined

`Readonly`message: string