Enum cumulus_pallet_xcmp_queue::pallet::Call

pub enum Call<T: Config> {
    service_overweight {
        index: OverweightIndex,
        weight_limit: Weight,
    },
    suspend_xcm_execution {},
    resume_xcm_execution {},
    update_suspend_threshold {
        new: u32,
    },
    update_drop_threshold {
        new: u32,
    },
    update_resume_threshold {
        new: u32,
    },
    update_threshold_weight {
        new: Weight,
    },
    update_weight_restrict_decay {
        new: Weight,
    },
    update_xcmp_max_individual_weight {
        new: Weight,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

service_overweight

Fields

index: OverweightIndex

weight_limit: Weight

Services a single overweight XCM.

• origin: Must pass ExecuteOverweightOrigin.
• index: The index of the overweight XCM to service
• weight_limit: The amount of weight that XCM execution may take.

Errors:

• BadOverweightIndex: XCM under index is not found in the Overweight storage map.
• BadXcm: XCM under index cannot be properly decoded into a valid XCM format.
• WeightOverLimit: XCM execution may use greater weight_limit.

Events:

• OverweightServiced: On success.

suspend_xcm_execution

Fields

Suspends all XCM executions for the XCMP queue, regardless of the sender’s origin.

• origin: Must pass ControllerOrigin.

resume_xcm_execution

Fields

Resumes all XCM executions for the XCMP queue.

Note that this function doesn’t change the status of the in/out bound channels.

• origin: Must pass ControllerOrigin.

update_suspend_threshold

Fields

new: u32

Overwrites the number of pages of messages which must be in the queue for the other side to be told to suspend their sending.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.suspend_value

update_drop_threshold

Fields

new: u32

Overwrites the number of pages of messages which must be in the queue after which we drop any further messages from the channel.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.drop_threshold

update_resume_threshold

Fields

new: u32

Overwrites the number of pages of messages which the queue must be reduced to before it signals that message sending may recommence after it has been suspended.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.resume_threshold

update_threshold_weight

Fields

new: Weight

Overwrites the amount of remaining weight under which we stop processing messages.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.threshold_weight

update_weight_restrict_decay

Fields

new: Weight

Overwrites the speed to which the available weight approaches the maximum weight. A lower number results in a faster progression. A value of 1 makes the entire weight available initially.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.weight_restrict_decay.

update_xcmp_max_individual_weight

Fields

new: Weight

Overwrite the maximum amount of weight any individual message may consume. Messages above this weight go into the overweight queue and may only be serviced explicitly.

• origin: Must pass Root.
• new: Desired value for QueueConfigData.xcmp_max_individual_weight.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_service_overweight(
    index: OverweightIndex,
    weight_limit: Weight
) -> Self

Create a call with the variant service_overweight.

pub fn new_call_variant_suspend_xcm_execution() -> Self

Create a call with the variant suspend_xcm_execution.

pub fn new_call_variant_resume_xcm_execution() -> Self

Create a call with the variant resume_xcm_execution.

pub fn new_call_variant_update_suspend_threshold(new: u32) -> Self

Create a call with the variant update_suspend_threshold.

pub fn new_call_variant_update_drop_threshold(new: u32) -> Self

Create a call with the variant update_drop_threshold.

pub fn new_call_variant_update_resume_threshold(new: u32) -> Self

Create a call with the variant update_resume_threshold.

pub fn new_call_variant_update_threshold_weight(new: Weight) -> Self

Create a call with the variant update_threshold_weight.

pub fn new_call_variant_update_weight_restrict_decay(new: Weight) -> Self

Create a call with the variant update_weight_restrict_decay.

pub fn new_call_variant_update_xcmp_max_individual_weight(new: Weight) -> Self

Create a call with the variant update_xcmp_max_individual_weight.

Trait Implementations

impl<T: Config> Clone for Call<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config> Debug for Call<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type Origin = <T as Config>::Origin

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>