Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

rdma_notify (3)

Name

rdma_notify - Notifies the librdmacm of an asynchronous event.

Synopsis

#include <rdma/rdma_cma.h>

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

Description

Librdmacm Programmer's Manual                                   RDMA_NOTIFY(3)



NAME
       rdma_notify - Notifies the librdmacm of an asynchronous event.

SYNOPSIS
       #include <rdma/rdma_cma.h>

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

ARGUMENTS
       id          RDMA identifier.

       event       Asynchronous event.

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

RETURN VALUE
       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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
NOTES
       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 neces-
       sary, 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
       rdma_connect(3), rdma_accept(3), rdma_listen(3)


       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded   from    ['https://www.openfabrics.org/down-
       loads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz', 'https://www.openfab-
       rics.org/downloads/libibverbs/libibverbs-1.1.8.tar.gz',
       'https://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.6.tar.gz',
       'https://www.openfabrics.org/downloads/libsdp/lib-
       sdp-1.1.108-0.15.gd7fdb72.tar.gz',   'https://www.openfabrics.org/down-
       loads/management/infiniband-diags-1.6.5.tar.gz',  'https://www.openfab-
       rics.org/downloads/management/libibmad-1.3.12.tar.gz',
       'https://www.openfabrics.org/downloads/management/libibu-
       mad-1.3.10.2.tar.gz',    'https://www.openfabrics.org/downloads/manage-
       ment/opensm-3.3.19.tar.gz',          'https://www.openfabrics.org/down-
       loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz', 'https://www.open-
       fabrics.org/downloads/qperf/qperf-0.4.9.tar.gz',  'https://www.openfab-
       rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',  'https://www.open-
       fabrics.org/downloads/rds-tools/rds-tools-2.0.4.tar.gz']

       Further information about this software can be found on the open source
       community website at http://www.openfabrics.org/.



librdmacm                         2007-05-15                    RDMA_NOTIFY(3)