rdma_join_multicast - Joins a multicast group.
#include <rdma/rdma_cma.h> int rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr *addr, void *context);
Librdmacm Programmer's Manual RDMA_JOIN_MULTICAST(3) NAME rdma_join_multicast - Joins a multicast group. SYNOPSIS #include <rdma/rdma_cma.h> int rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr *addr, void *context); ARGUMENTS 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 Joins a multicast group and attaches an associated QP to 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 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 mul- ticast address to an RDMA device, unless a specific source address is provided. The user must call rdma_leave_multicast to leave the multi- cast group and release any multicast resources. After the join opera- tion completes, if a QP is associated with the rdma_cm_id, it is auto- matically 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 con- text is returned to the user through the private_data field in the rdma_cm_event. 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_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_create_qp(3), rdma_get_cm_event(3) librdmacm 2008-01-02 RDMA_JOIN_MULTICAST(3)