Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_attach_mcast (3)

Name

ibv_attach_mcast - attach and detach a queue pair (QPs) to/from a multicast group

Synopsis

#include <infiniband/verbs.h>

int ibv_attach_mcast(struct ibv_qp *qp, const union ibv_gid *gid,
uint16_t lid);

int ibv_detach_mcast(struct ibv_qp *qp, const union ibv_gid *gid,
uint16_t lid);

Description

Libibverbs Programmer's Manual                             IBV_ATTACH_MCAST(3)



NAME
       ibv_attach_mcast,  ibv_detach_mcast  -  attach  and detach a queue pair
       (QPs) to/from a multicast group

SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_attach_mcast(struct ibv_qp *qp, const union ibv_gid *gid,
                            uint16_t lid);

       int ibv_detach_mcast(struct ibv_qp *qp, const union ibv_gid *gid,
                            uint16_t lid);

DESCRIPTION
       ibv_attach_mcast() attaches the QP qp to  the  multicast  group  having
       MGID gid and MLID lid.

       ibv_detach_mcast()  detaches  the  QP  qp to the multicast group having
       MGID gid and MLID lid.

RETURN VALUE
       ibv_attach_mcast() and ibv_detach_mcast() returns 0 on success, or  the
       value of errno on failure (which indicates the failure reason).


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
NOTES
       Only QPs of Transport Service Type IBV_QPT_UD may be attached to multi-
       cast groups.

       If a QP is attached to the same multicast group multiple times, the  QP
       will still receive a single copy of a multicast message.

       In  order  to receive multicast messages, a join request for the multi-
       cast group must be sent to the subnet administrator (SA), so  that  the
       fabric's  multicast  routing  is  configured to deliver messages to the
       local port.

SEE ALSO
       ibv_create_qp(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>


              This   software   was   built   from   source    available    at
              https://github.com/oracle/solaris-userland.  The original commu-
              nity  source   was   downloaded   from    ['https://www.openfab-
              rics.org/downloads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz',
              'https://www.openfabrics.org/downloads/libibverbs/libib-
              verbs-1.1.8.tar.gz',          'https://www.openfabrics.org/down-
              loads/libmlx4/libmlx4-1.0.6.tar.gz',       'https://www.openfab-
              rics.org/downloads/libsdp/libsdp-1.1.108-0.15.gd7fdb72.tar.gz',
              'https://www.openfabrics.org/downloads/management/infiniband-
              diags-1.6.5.tar.gz', 'https://www.openfabrics.org/downloads/man-
              agement/libibmad-1.3.12.tar.gz',           'https://www.openfab-
              rics.org/downloads/management/libibumad-1.3.10.2.tar.gz',
              'https://www.openfabrics.org/downloads/manage-
              ment/opensm-3.3.19.tar.gz',   'https://www.openfabrics.org/down-
              loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz',
              'https://www.openfabrics.org/down-
              loads/qperf/qperf-0.4.9.tar.gz',           'https://www.openfab-
              rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',
              'https://www.openfabrics.org/downloads/rds-tools/rds-
              tools-2.0.4.tar.gz']

              Further information about this software can be found on the open
              source community website at http://www.openfabrics.org/.



libibverbs                        2006-10-31               IBV_ATTACH_MCAST(3)