Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

rdma_create_event_channel (3)

Name

rdma_create_event_channel - Open a channel used to report communication events.

Synopsis

#include <rdma/rdma_cma.h>

struct rdma_event_channel * rdma_create_event_channel (void);

Description

Librdmacm Programmer's Manual
                                                  RDMA_CREATE_EVENT_CHANNEL(3)



NAME
       rdma_create_event_channel - Open a channel used to report communication
       events.

SYNOPSIS
       #include <rdma/rdma_cma.h>

       struct rdma_event_channel * rdma_create_event_channel (void);

ARGUMENTS
       void        no arguments

DESCRIPTION
       Asynchronous events are reported to users through event channels.

RETURN VALUE
       Returns a pointer to the created event channel, or NULL if the  request
       fails.  On failure, errno will be set to indicate the failure reason.


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


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
NOTES
       Event  channels  are  used  to direct all events on an rdma_cm_id.  For
       many clients, a single event channel may be sufficient,  however,  when
       managing  a  large  number of connections or cm_id's, users may find it
       useful to direct events for different cm_id's to different channels for
       processing.

       All   created   event   channels   must   be   destroyed   by   calling
       rdma_destroy_event_channel.  Users  should  call  rdma_get_cm_event  to
       retrieve events on an event channel.

       Each event channel is mapped to a file descriptor.  The associated file
       descriptor can be used and manipulated like any other fd to change  its
       behavior.   Users  may make the fd non-blocking, poll or select the fd,
       etc.

SEE ALSO
       rdma_cm(7), rdma_get_cm_event(3), rdma_destroy_event_channel(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_CREATE_EVENT_CHANNEL(3)