Skip to main content

pamoja_gateway_station_message_broadcast

pamoja_ffi::gateway_station

Function pamoja_gateway_station_message_broadcast 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_gateway_station_message_broadcast(
    message: *const PamojaGatewayStationMessage,
    index: usize,
    out_frame: *mut PamojaGatewayStationBroadcast,
    out_pdu: *mut *mut PamojaBuffer,
) -> PamojaStatus
Expand description

Reads one frame of a schedule.

§Arguments

  • message - the schedule.
  • index - which frame, below the broadcast_count its fields report.
  • out_frame - receives when and how to transmit it.
  • out_pdu - receives its bytes, which the caller releases with pamoja_buffer_free.

§Returns

PamojaStatus::Ok once read, or PamojaStatus::InvalidArgument for an index past the schedule or a message that is not one.

§Safety

message must be a live handle, and both out pointers must point to writable storage.