rdma_notify(3) — Linux manual page

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

RDMA_NOTIFY(3)          Librdmacm Programmer's Manual         RDMA_NOTIFY(3)

NAME top

       rdma_notify - Notifies the librdmacm of an asynchronous event.

SYNOPSIS top

       #include <rdma/rdma_cma.h>

       int rdma_notify (struct rdma_cm_id *id, enum ibv_event_type event);

ARGUMENTS top

       id          RDMA identifier.

       event       Asynchronous event.

DESCRIPTION top

       Used to notify the librdmacm of asynchronous events that have
       occurred on a QP associated with the rdma_cm_id.

RETURN VALUE top

       Returns 0 on success, or -1 on error.  If an error occurs, errno will
       be set to indicate the failure reason.  If errno is set to EISCONN
       (transport endpoint is already connected), this indicates that the
       the underlying communication manager established the connection
       before the call to rdma_notify could be processed.  In this case, the
       error may safely be ignored.

NOTES top

       Asynchronous events that occur on a QP are reported through the
       user's device event handler.  This routine is used to notify the
       librdmacm of communication events.  In most cases, use of this
       routine is not necessary, however if connection establishment is done
       out of band (such as done through Infiniband), it's possible to
       receive data on a QP that is not yet considered connected.  This
       routine forces the connection into an established state in this case
       in order to handle the rare situation where the connection never
       forms on its own.  Calling this routine ensures the delivery of the
       RDMA_CM_EVENT_ESTABLISHED event to the application.  Events that
       should be reported to the CM are: IB_EVENT_COMM_EST.

SEE ALSO top

       rdma_connect(3), rdma_accept(3), rdma_listen(3)

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 2020-08-13.  (At
       that time, the date of the most recent commit that was found in the
       repository was 2020-08-05.)  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

librdmacm                        2007-05-15                   RDMA_NOTIFY(3)

Pages that refer to this page: rdma_cm(7)