Skip to main content

webui_streaming_session_create

Function webui_streaming_session_create 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn webui_streaming_session_create( handler_ptr: *mut c_void, protocol_ptr: *const webui_protocol_t, entry_id: *const c_char, request_path: *const c_char, ) -> *mut webui_streaming_session_t
Expand description

Open a host-driven progressive response for a streaming entry.

Unlike webui_handler_render, which produces the whole document in one call, the returned session hands back one chunk per call so the host owns the socket, the write order, and backpressure. Any nonce previously set with webui_handler_set_nonce is captured for the life of the session.

Returns NULL on error; call webui_last_error for details. The handle must be released with webui_streaming_session_destroy even after webui_streaming_session_finish succeeds.

§Thread Safety

A session is not thread-safe. Drive one session from one thread at a time. Independent sessions may run concurrently on the same handler and protocol.

§Safety