1RDMA_JOIN_MULTICAST(3)   Librdmacm Programmer's Manual  RDMA_JOIN_MULTICAST(3)
2
3
4

NAME

6       rdma_join_multicast - Joins a multicast group.
7

SYNOPSIS

9       #include <rdma/rdma_cma.h>
10
11       int  rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr *addr,
12       void *context);
13

ARGUMENTS

15       id          Communication identifier associated with the request.
16
17       addr        Multicast address identifying the group to join.
18
19       context     User-defined context associated with the join request.
20

DESCRIPTION

22       Joins a multicast group and attaches an associated QP to the group.
23

RETURN VALUE

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

NOTES

29       Before  joining  a  multicast group, the rdma_cm_id must be bound to an
30       RDMA device by calling rdma_bind_addr  or  rdma_resolve_addr.   Use  of
31       rdma_resolve_addr requires the local routing tables to resolve the mul‐
32       ticast address to an RDMA device, unless a specific source  address  is
33       provided.   The user must call rdma_leave_multicast to leave the multi‐
34       cast group and release any multicast resources.  After the join  opera‐
35       tion  completes, if a QP is associated with the rdma_cm_id, it is auto‐
36       matically attached to the multicast group when the multicast  event  is
37       retrieved  by the user.  Otherwise, the user is responsible for calling
38       ibv_attach_mcast to bind the QP to the multicast group.  The join  con‐
39       text  is  returned  to  the  user through the private_data field in the
40       rdma_cm_event.
41

SEE ALSO

43       rdma_leave_multicast(3),    rdma_bind_addr(3),    rdma_resolve_addr(3),
44       rdma_create_qp(3), rdma_get_cm_event(3)
45
46
47
48librdmacm                         2008-01-02            RDMA_JOIN_MULTICAST(3)
Impressum