ibv_attach_mcast(3) — Linux manual page

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

IBV_ATTACH_MCAST(3)   Libibverbs Programmer’s Manual  IBV_ATTACH_MCAST(3)

NAME         top

       ibv_attach_mcast, ibv_detach_mcast - attach and detach a queue
       pair (QPs) to/from a multicast group

SYNOPSIS         top

              #include <infiniband/verbs.h>

              int ibv_attach_mcast(struct ibv_qp *qp, const union ibv_gid *gid, uint16_t lid);

              int ibv_detach_mcast(struct ibv_qp *qp, const union ibv_gid *gid, uint16_t lid);

DESCRIPTION         top

       ibv_attach_mcast() attaches the QP qp to the multicast group
       having MGID gid and MLID lid.

       ibv_detach_mcast() detaches the QP qp to the multicast group
       having MGID gid and MLID lid.

RETURN VALUE         top

       ibv_attach_mcast() and ibv_detach_mcast() returns 0 on success, or
       the value of errno on failure (which indicates the failure
       reason).

NOTES         top

       Only QPs of Transport Service Type IBV_QPT_UD may be attached to
       multicast groups.

       If a QP is attached to the same multicast group multiple times,
       the QP will still receive a single copy of a multicast message.

       In order to receive multicast messages, a join request for the
       multicast group must be sent to the subnet administrator (SA), so
       that the fabric’s multicast routing is configured to deliver
       messages to the local port.

SEE ALSO         top

       ibv_create_qp(3)

AUTHOR         top

       Dotan Barak ⟨dotanba@gmail.com⟩

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

libibverbs                      2006-10-31            IBV_ATTACH_MCAST(3)