contrib/ofed/libibverbs/man/ibv_attach_mcast.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_ATTACH_MCAST 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_attach_mcast, ibv_detach_mcast \- attach and detach a queue pair
   6 (QPs) to/from a multicast group
   7 .SH "SYNOPSIS"
   8 .nf
   9 .B #include <infiniband/verbs.h>
  10 .sp
  11 .BI "int ibv_attach_mcast(struct ibv_qp " "*qp" ", const union ibv_gid " "*gid" ",
  12 .BI "                     uint16_t " "lid" ");
  13 .sp
  14 .BI "int ibv_detach_mcast(struct ibv_qp " "*qp" ", const union ibv_gid " "*gid" ",
  15 .BI "                     uint16_t " "lid" ");
  16 .fi
  17 .SH "DESCRIPTION"
  18 .B ibv_attach_mcast()
  19 attaches the QP
  20 .I qp
  21 to the multicast group having MGID
  22 .I gid
  23 and MLID
  24 .I lid\fR.
  25 .PP
  26 .B ibv_detach_mcast()
  27 detaches the QP
  28 .I qp
  29 to the multicast group having MGID
  30 .I gid
  31 and MLID
  32 .I lid\fR.
  33 .SH "RETURN VALUE"
  34 .B ibv_attach_mcast()
  35 and
  36 .B ibv_detach_mcast()
  37 returns 0 on success, or the value of errno on failure (which indicates the failure reason).
  38 .SH "NOTES"
  39 Only QPs of Transport Service Type
  40 .BR IBV_QPT_UD
  41 may be attached to multicast groups.
  42 .PP
  43 If a QP is attached to the same multicast group multiple times, the QP will still receive a single copy of a multicast message.
  44 .PP
  45 In order to receive multicast messages, a join request for the
  46 multicast group must be sent to the subnet administrator (SA), so that
  47 the fabric's multicast routing is configured to deliver messages to
  48 the local port.
  49 .SH "SEE ALSO"
  50 .BR ibv_create_qp (3)
  51 .SH "AUTHORS"
  52 .TP
  53 Dotan Barak <dotanb@mellanox.co.il>