rdma_write_cm_event - Man Page

Write an event into a CM.

Synopsis

#include <rdma/rdma_cma.h>

int rdma_write_cm_event(struct rdma_cm_id *id, enum rdma_cm_event_type event, int status, uint64_t arg);

Arguments

id      The RDMA identifier associated with the reported rdma_cm_event.

event   The communication event value to report. This should be set to RDMA_CM_EVENT_USER.

status  The status value reported in the rdma_cm_event.

arg     A user-specified value reported in the rdma_cm_event.

Description

Write an event into a CM, with a status and an argument.

Return Value

On success 0 is returned, on error -1 is returned, errno will be set to indicate the failure reason.

Notes

This call allows an application to write a user-defined event to the event channel associated with the specified rdma_cm_id. Valid user events are: RDMA_CM_EVENT_USER. Applications may use this for internal signaling purposes, such as waking a thread blocked on the event channel.

See Also

rdma_get_cm_event(3)

Author

Mark Zhang < <markzhang@nvidia.com> >

Referenced By

rdma_cm(7), rdma_get_cm_event(3).

2025-02-06 Librdmacm Programmer's Manual