contrib/ofed/librdmacm/man/rdma_leave_multicast.3

   1 .TH "RDMA_LEAVE_MULTICAST" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   2 .SH NAME
   3 rdma_leave_multicast \- Leaves a multicast group.
   4 .SH SYNOPSIS
   5 .B "#include <rdma/rdma_cma.h>"
   6 .P
   7 .B "int" rdma_leave_multicast
   8 .BI "(struct rdma_cm_id *" id ","
   9 .BI "struct sockaddr *" addr ");"
  10 .SH ARGUMENTS
  11 .IP "id" 12
  12 Communication identifier associated with the request.
  13 .IP "addr" 12
  14 Multicast address identifying the group to leave.
  15 .SH "DESCRIPTION"
  16 Leaves a multicast group and detaches an associated QP from the group.
  17 .SH "NOTES"
  18 Calling this function before a group has been fully joined results in
  19 canceling the join operation.  Users should be aware that messages
  20 received from the multicast group may stilled be queued for
  21 completion processing immediately after leaving a multicast group.
  22 Destroying an rdma_cm_id will automatically leave all multicast groups.
  23 .SH "SEE ALSO"
  24 rdma_join_multicast(3), rdma_destroy_qp(3)