@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / OutgoingMessageProcessor

Class: abstract OutgoingMessageProcessor<T, Config>

Used by various module sub-types that may need to be configured

Extends

• ProtocolModule<Config>

Extended by

Type Parameters

• T

• Config = NoConfig

Constructors

new OutgoingMessageProcessor()

new OutgoingMessageProcessor<T, Config>(): OutgoingMessageProcessor<T, Config>

Returns

OutgoingMessageProcessor<T, Config>

Inherited from

ProtocolModule.constructor

Properties

currentConfig

protected currentConfig: undefined | Config

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

ProtocolModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

messageType

abstract messageType: string

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:73

parent?

optional parent: ProtocolEnvironment

Inherited from

ProtocolModule.parent

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:14

type

abstract type: FlexibleProvablePure<T> & object

Type declaration

name

name: string

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:71

Accessors

areProofsEnabled

Get Signature

get areProofsEnabled(): undefined | AreProofsEnabled

Returns

undefined | AreProofsEnabled

Inherited from

ProtocolModule.areProofsEnabled

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:16

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

ProtocolModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

assertTrue()

assertTrue(b, msg?): void

Parameters

• b: Bool

• msg?: string

Returns

void

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:32

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ProtocolModule.create

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:20

dummy()

abstract dummy(): T

Returns

T

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:75

getMessageType()

getMessageType(): Field

Returns

Field

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:59

process()

abstract process(message, args): AccountUpdate[]

Parameters

• message: T

• args: MessageProcessorArgs

Returns

AccountUpdate[]

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:77

processMessage()

processMessage(message, args): object

Parameters

• message: T

• args: MessageProcessorArgs

Returns

object

accountUpdates

accountUpdates: AccountUpdate[]

status

status: Bool

statusMessage?

optional statusMessage: string

Defined in

packages/protocol/src/settlement/modularity/OutgoingMessageProcessor.ts:39

start()

start(): Promise<void>

Returns

Promise<void>

Inherited from

ProtocolModule.start

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:24