Go to main content

man pages section 3: DAX Library Functions

Exit Print View

Updated: Friday, August 13, 2021
 
 

dax_cancel (3DAX)

Name

dax_cancel - cancel a command in a queue

Synopsis

cc [ flag... ] file... -ldax [ library...]

#include <dax.h>

dax_status_t
dax_cancel(dax_queue_t *queue, void *udata);

Description

This function cancels the oldest command posted in queue whose udata matches udata. The cancelled command completes with a dax_poll_t status of DAX_ECANCEL. The destination buffer may have partial results.

If it finds a matching command that is complete, the status of the command is not changed to DAX_ECANCEL.

Return Values

Returns one of the following values:

DAX_SUCCESS

A command with matching udata is found. The command completed or was cancelled.

DAX_ENOMATCH

No command with matching udata found

DAX_ETHREAD

The calling thread did not create the queue

DAX_EINTERNAL

Unknown internal error. Caller must stop using ctx.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/library
Interface Stability
Committed

See Also

libdax(3LIB), dax_post(3DAX), dax_poll(3DAX)

Notes

A cancelled command must be reaped by using the dax_poll() function.