contrib/ofed/librdmacm/man/rdma_leave_multicast.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_LEAVE_MULTICAST" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_leave_multicast \- Leaves a multicast group.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_leave_multicast
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct sockaddr *" addr ");"
  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 leave.
  16 .SH "DESCRIPTION"
  17 Leaves a multicast group and detaches an associated QP from the group.
  18 .SH "RETURN VALUE"
  19 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  20 set to indicate the failure reason.
  21 .SH "NOTES"
  22 Calling this function before a group has been fully joined results in
  23 canceling the join operation.  Users should be aware that messages
  24 received from the multicast group may stilled be queued for
  25 completion processing immediately after leaving a multicast group.
  26 Destroying an rdma_cm_id will automatically leave all multicast groups.
  27 .SH "SEE ALSO"
  28 rdma_join_multicast(3), rdma_destroy_qp(3)