Skip to main content

pamoja_gateway_network_notices

Function pamoja_gateway_network_notices 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_gateway_network_notices( network: *mut PamojaGatewayNetwork, out_notices: *mut PamojaGatewayNetworkNotice, capacity: usize, out_len: *mut usize, ) -> PamojaStatus
Expand description

Takes the devices relays have reported hearing and could not verify.

A relay carries these in the MAC commands of its own uplinks, alongside whatever else that uplink was for, so they wait in the network until they are read. Every notice is taken: a second call returns only what arrived since the first.

§Arguments

  • network - the network.
  • out_notices - where to write them, or null to count what is waiting.
  • capacity - how many notices that buffer holds.
  • out_len - receives how many are waiting, which may be more than were written.

§Returns

PamojaStatus::Ok when every notice was written, and PamojaStatus::InvalidArgument when the buffer was too small, in which case none were taken and *out_len says how many there are.

§Errors

Returns PamojaStatus::InvalidArgument for a null handle or out pointer.

§Safety

network must be a live handle, out_notices must point at capacity writable notices or be null, and out_len must be writable.