Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

rdma_leave_multicast (3)

Name

rdma_leave_multicast - Leaves a multicast group.

Synopsis

#include <rdma/rdma_cma.h>

int   rdma_leave_multicast  (struct  rdma_cm_id  *id,  struct  sockaddr
*addr);

Description

Librdmacm Programmer's Manual                          RDMA_LEAVE_MULTICAST(3)



NAME
       rdma_leave_multicast - Leaves a multicast group.

SYNOPSIS
       #include <rdma/rdma_cma.h>

       int   rdma_leave_multicast  (struct  rdma_cm_id  *id,  struct  sockaddr
       *addr);

ARGUMENTS
       id          Communication identifier associated with the request.

       addr        Multicast address identifying the group to leave.

DESCRIPTION
       Leaves a multicast group and detaches an associated QP from the group.

RETURN VALUE
       Returns 0 on success, or -1 on error.  If an error occurs,  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
       Calling  this  function before a group has been fully joined results in
       canceling the join operation.  Users  should  be  aware  that  messages
       received  from the multicast group may stilled be queued for completion
       processing immediately after leaving a multicast group.  Destroying  an
       rdma_cm_id will automatically leave all multicast groups.

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       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/.

SEE ALSO
       rdma_join_multicast(3), rdma_destroy_qp(3)




librdmacm                         2007-05-15           RDMA_LEAVE_MULTICAST(3)