Skip to main content

pamoja_lora_plan_join_plan

Function pamoja_lora_plan_join_plan 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_lora_plan_join_plan( plan: *const PamojaLoraPlan, index: u16, out_join_plan: *mut PamojaLoraJoinPlan, ) -> PamojaStatus
Expand description

Returns one run of join channels that selects a plan.

§Arguments

  • plan - the plan to read.
  • index - the run’s position, below the count pamoja_lora_plan_rules reports.
  • out_join_plan - set to the run on success.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns PamojaStatus::InvalidArgument if either pointer is null or the index is past the end, which it always is for a plan that was built rather than published.

§Safety

plan must be a live plan handle and out_join_plan must point at writable storage for one PamojaLoraJoinPlan.