Trait pallet_message_queue::pallet::Config

source · 
pub trait Config: Config {
    type RuntimeEvent: From<Event<Self>> + IsType<<Self as Config>::RuntimeEvent>;
    type WeightInfo: WeightInfo;
    type MessageProcessor: ProcessMessage;
    type Size: BaseArithmetic + Unsigned + Copy + Into<u32> + Member + Encode + Decode + MaxEncodedLen + TypeInfo + Default;
    type QueueChangeHandler: OnQueueChanged<<Self::MessageProcessor as ProcessMessage>::Origin>;
    type HeapSize: Get<Self::Size>;
    type MaxStale: Get<u32>;
    type ServiceWeight: Get<Option<Weight>>;
}
Expand description

The module configuration trait.

Required Associated Types§

The overarching event type.

Weight information for extrinsics in this pallet.

Processor for a message.

Must be set to mock_helpers::NoopMessageProcessor for benchmarking. Other message processors that consumes exactly (1, 1) weight for any give message will work as well. Otherwise the benchmarking will also measure the weight of the message processor, which is not desired.

Page/heap size type.

Code to be called when a message queue changes - either with items introduced or removed.

The size of the page; this implies the maximum message size which can be sent.

A good value depends on the expected message sizes, their weights, the weight that is available for processing them and the maximal needed message size. The maximal message size is slightly lower than this as defined by MaxMessageLenOf.

The maximum number of stale pages (i.e. of overweight messages) allowed before culling can happen. Once there are more stale pages than this, then historical pages may be dropped, even if they contain unprocessed overweight messages.

The amount of weight (if any) which should be provided to the message queue for servicing enqueued items.

This may be legitimately None in the case that you will call ServiceQueues::service_queues manually.

Implementors§