Class SecureChannelStatusMessageSchema

Define a schema to encode / decode convert type T to type E.

Hierarchy (view full)

Schema<StatusMessage, Uint8Array>
- SecureChannelStatusMessageSchema

Index

Constructors

Methods

decode decodeInternal encode encodeInternal validate

Constructors

constructor

new SecureChannelStatusMessageSchema(): SecureChannelStatusMessageSchema
Returns SecureChannelStatusMessageSchema
Inherited from Schema.constructor

Methods

decode

decode(encoded, validate?): StatusMessage
Decodes the encoded data using the schema.
Parameters
- encoded: Uint8Array
- Optionalvalidate: boolean
Returns StatusMessage
Inherited from Schema.decode
- Defined in packages/types/dist/esm/schema/Schema.d.ts:11

decodeInternal

decodeInternal(bytes): {
    generalStatus: number;
    protocolId: number;
    protocolStatus: number;
    remainingBytes: undefined | Uint8Array;
}
Parameters
- bytes: Uint8Array
Returns {
    generalStatus: number;
    protocolId: number;
    protocolStatus: number;
    remainingBytes: undefined | Uint8Array;
}
- generalStatus: number
- protocolId: number
- protocolStatus: number
- remainingBytes: undefined | Uint8Array
Overrides Schema.decodeInternal
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelStatusMessageSchema.d.ts:15

encode

encode(value): Uint8Array
Encodes the value using the schema.
Parameters
- value: StatusMessage
Returns Uint8Array
Inherited from Schema.encode
- Defined in packages/types/dist/esm/schema/Schema.d.ts:9

encodeInternal

encodeInternal(__namedParameters): Uint8Array
Parameters
- __namedParameters: StatusMessage
Returns Uint8Array
Overrides Schema.encodeInternal
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelStatusMessageSchema.d.ts:14

validate

validate(_value): void
Optional validator that can be used to enforce constraints on the data before encoding / after decoding.
Parameters
- _value: StatusMessage
Returns void
Inherited from Schema.validate
- Defined in packages/types/dist/esm/schema/Schema.d.ts:15