Skip to main content

pamoja_loopback_transport_recv_within

Function pamoja_loopback_transport_recv_within 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_loopback_transport_recv_within( transport: *mut PamojaLoopbackTransport, timeout_ms: u64, out_message: *mut *mut PamojaMessage, out_timed_out: *mut bool, ) -> PamojaStatus
Expand description

Waits a limited time for the next message on a subscribed topic.

Running out of time loses nothing: a message that arrives afterwards waits for the next receive.

§Arguments

  • transport - the link.
  • timeout_ms - how long to wait, in milliseconds.
  • out_message - receives a message handle, or null when the time ran out.
  • out_timed_out - receives whether the time ran out before a message arrived.

§Returns

PamojaStatus::Ok with a message or with the time run out, or PamojaStatus::Closed if the link is not connected.

§Safety

transport must be a live handle, and out_message and out_timed_out must be writable.