rdma_join_multicast(3) — Linux manual page

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

RDMA_JOIN_MULTICAST(3)Librdmacm Programmer's ManualDMA_JOIN_MULTICAST(3)

NAME         top

       rdma_join_multicast - Joins a multicast group.

SYNOPSIS         top

       #include <rdma/rdma_cma.h>

       int rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr
       *addr, void *context);

ARGUMENTS         top

       id          Communication identifier associated with the request.

       addr        Multicast address identifying the group to join.

       context     User-defined context associated with the join
                   request.

DESCRIPTION         top

       Joins a multicast group and attaches an associated QP to 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

       Before joining a multicast group, the rdma_cm_id must be bound to
       an RDMA device by calling rdma_bind_addr or rdma_resolve_addr.
       Use of rdma_resolve_addr requires the local routing tables to
       resolve the multicast address to an RDMA device, unless a
       specific source address is provided.  The user must call
       rdma_leave_multicast to leave the multicast group and release any
       multicast resources.  After the join operation completes, if a QP
       is associated with the rdma_cm_id, it is automatically attached
       to the multicast group when the multicast event is retrieved by
       the user.  Otherwise, the user is responsible for calling
       ibv_attach_mcast to bind the QP to the multicast group.  The join
       context is returned to the user through the private_data field in
       the rdma_cm_event.

SEE ALSO         top

       rdma_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3),
       rdma_create_qp(3), rdma_get_cm_event(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 2021-08-27.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-08-18.)  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                      2008-01-02         RDMA_JOIN_MULTICAST(3)

Pages that refer to this page: rdma_get_cm_event(3)rdma_join_multicast_ex(3)rdma_leave_multicast(3)rdma_cm(7)