rdma_write_cm_event(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURN VALUE | NOTES | SEE ALSO | AUTHOR | COLOPHON

RDMA_WR...CM_EVENT(3) Librdmacm Programmer's Manual RDMA_WR...CM_EVENT(3)

NAME         top

       RDMA_WRITE_CM_EVENT - Write an event into a CM.

SYNOPSIS         top

       #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         top

       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         top

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

RETURN VALUE         top

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

NOTES         top

       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         top

       rdma_get_cm_event(3)

AUTHOR         top

       Mark Zhang < <markzhang@nvidia.com> >

COLOPHON         top

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       linux-rdma@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2026-01-16.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2026-01-15.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                2025-02-06          RDMA_WR...CM_EVENT(3)

Pages that refer to this page: rdma_cm(7)