rdma_leave_multicast(3) — Linux manual page

RDMA_LE...LTICAST(3)  Librdmacm Programmer's Manual  RDMA_LE...LTICAST(3)

NAME         top

       rdma_leave_multicast - Leaves a multicast group.

SYNOPSIS         top

       #include <rdma/rdma_cma.h>

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

ARGUMENTS         top

       id          Communication identifier associated with the request.

       addr        Multicast address identifying the group to leave.

DESCRIPTION         top

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

RETURN VALUE         top

       Returns 0 on success, or -1 on error.  If an error occurs, errno
       will be set to indicate the failure reason.

NOTES         top

       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.

SEE ALSO         top

       rdma_join_multicast(3), rdma_destroy_qp(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 2025-08-11.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2025-08-04.)  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_LE...LTICAST(3)

Pages that refer to this page: rdma_join_multicast(3),  rdma_join_multicast_ex(3),  rdma_cm(7)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.