.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.2 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "RDMA_WRITE_CM_EVENT" "3" "2025-02-06" "" "Librdmacm Programmer's Manual"
.SH Name
RDMA_WRITE_CM_EVENT \- Write an event into a CM.
.SH SYNOPSIS
.sp
#include <rdma/rdma_cma.h>
.sp
int rdma_write_cm_event(struct rdma_cm_id *id, enum rdma_cm_event_type event, int status, uint64_t arg);
.SH ARGUMENTS
.sp
id      The RDMA identifier associated with the reported rdma_cm_event.
.sp
event   The communication event value to report. This should be set to RDMA_CM_EVENT_USER.
.sp
status  The status value reported in the rdma_cm_event.
.sp
arg     A user\-specified value reported in the rdma_cm_event.
.SH DESCRIPTION
.sp
Write an event into a CM, with a status and an argument.
.SH RETURN VALUE
.sp
On success 0 is returned, on error \-1 is returned, errno will be set to indicate the failure reason.
.SH NOTES
.sp
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.
.SH SEE ALSO
.sp
rdma_get_cm_event(3)
.SH AUTHOR
.sp
Mark Zhang <\%<markzhang@\:nvidia\:.com>>
.\" End of generated man page.