contrib/ofed/librdmacm/man/rdma_join_multicast.3

   1 .TH "RDMA_JOIN_MULTICAST" 3 "2008-01-02" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   2 .SH NAME
   3 rdma_join_multicast \- Joins a multicast group.
   4 .SH SYNOPSIS
   5 .B "#include <rdma/rdma_cma.h>"
   6 .P
   7 .B "int" rdma_join_multicast
   8 .BI "(struct rdma_cm_id *" id ","
   9 .BI "struct sockaddr *" addr ","
  10 .BI "void *" context ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 Communication identifier associated with the request.
  14 .IP "addr" 12
  15 Multicast address identifying the group to join.
  16 .IP "context" 12
  17 User-defined context associated with the join request.
  18 .SH "DESCRIPTION"
  19 Joins a multicast group and attaches an associated QP to the group.
  20 .SH "NOTES"
  21 Before joining a multicast group, the rdma_cm_id must be bound to
  22 an RDMA device by calling rdma_bind_addr or rdma_resolve_addr.  Use of
  23 rdma_resolve_addr requires the local routing tables to resolve the
  24 multicast address to an RDMA device, unless a specific source address
  25 is provided.  The user must call rdma_leave_multicast to leave the
  26 multicast group and release any multicast resources.  After the join
  27 operation completes, any associated QP is automatically attached to the
  28 multicast group, and the join context is returned to the user through
  29 the private_data field in the rdma_cm_event.
  30 .SH "SEE ALSO"
  31 rdma_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_create_qp(3),
  32 rdma_get_cm_event(3)