contrib/ofed/librdmacm/man/rdma_notify.3

   1 .TH "RDMA_NOTIFY" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   2 .SH NAME
   3 rdma_notify \- Notifies the librdmacm of an asynchronous event.
   4 .SH SYNOPSIS
   5 .B "#include <rdma/rdma_cma.h>"
   6 .P
   7 .B "int" rdma_notify
   8 .BI "(struct rdma_cm_id *" id ","
   9 .BI "enum ibv_event_type " event ");"
  10 .SH ARGUMENTS
  11 .IP "id" 12
  12 RDMA identifier.
  13 .IP "event" 12
  14 Asynchronous event.
  15 .SH "DESCRIPTION"
  16 Used to notify the librdmacm of asynchronous events that have occurred
  17 on a QP associated with the rdma_cm_id.
  18 .SH "NOTES"
  19 Asynchronous events that occur on a QP are reported through the user's
  20 device event handler.  This routine is used to notify the librdmacm of
  21 communication events.  In most cases, use of this routine is not
  22 necessary, however if connection establishment is done out of band
  23 (such as done through Infiniband), it's possible to receive data on a
  24 QP that is not yet considered connected.  This routine forces the
  25 connection into an established state in this case in order to handle
  26 the rare situation where the connection never forms on its own.
  27 Events that should be reported to the CM are: IB_EVENT_COMM_EST.
  28 .SH "SEE ALSO"
  29 rdma_connect(3), rdma_accept(3), rdma_listen(3)