pdcomm_gem_spool_purge

Function

Removes every spooled message locally.

PdcommStatus pdcomm_gem_spool_purge(PdcommTcpEndpoint *endpoint, PdcommGemSpoolWriteInfo *info)

Declared in: #include <pdcomm_gem_spooling.h>

Requires a stopped endpoint and no transmission run, in-flight delivery, or pending dequeue. Purging deactivates spooling and clears the start and full times; affected_count reports the removed entries.

Parameters

Name	Description
endpoint	Stopped endpoint with an Equipment spool.
info	Receives the outcome (#PDCOMM_GEM_SPOOL_PURGED). Must not be NULL.

Returns

#PDCOMM_OK or #PDCOMM_SPOOL_UNCONFIRMED when installed; #PDCOMM_INVALID_ARGUMENT when info or endpoint is NULL or info is too small; #PDCOMM_INVALID_STATE when the endpoint is not stopped or has no Equipment spool; #PDCOMM_BACKPRESSURE when a staged TCP event is pending or a delivery, dequeue, or transmission run is pending; a persistence error such as #PDCOMM_IO_ERROR (spool unchanged); #PDCOMM_POISONED after a contained panic.