ibv_detach_mcast(3) [debian man page]

IBV_ATTACH_MCAST(3)					  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).

NOTES

       Only QPs of Transport Service Type IBV_QPT_UD may be attached to multicast 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 multicast 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>

libibverbs							    2006-10-31						       IBV_ATTACH_MCAST(3)

RDMA_JOIN_MULTICAST(3)					   Librdmacm Programmer's Manual				    RDMA_JOIN_MULTICAST(3)

NAME

       rdma_join_multicast - Joins a multicast group.

SYNOPSIS

       #include <rdma/rdma_cma.h>

       int rdma_join_multicast (struct rdma_cm_id *id, struct sockaddr *addr, void *context);

ARGUMENTS

       id	   Communication identifier associated with the request.

       addr	   Multicast address identifying the group to join.

       context	   User-defined context associated with the join request.

DESCRIPTION

       Joins a multicast group and attaches an associated QP to the group.

RETURN VALUE

       Returns 0 on success, or -1 on error.  If an error occurs, errno will be set to indicate the failure reason.

NOTES

       Before  joining	a  multicast group, the rdma_cm_id must be bound to an RDMA device by calling rdma_bind_addr or rdma_resolve_addr.  Use of
       rdma_resolve_addr requires the local routing tables to resolve the multicast address to an RDMA device, unless a specific source address is
       provided.  The user must call rdma_leave_multicast to leave the multicast group and release any multicast resources.  After the join opera-
       tion completes, if a QP is associated with the rdma_cm_id, it is automatically attached to the multicast group when the multicast event	is
       retrieved  by  the  user.  Otherwise, the user is responsible for calling ibv_attach_mcast to bind the QP to the multicast group.  The join
       context is returned to the user through the private_data field in the rdma_cm_event.

SEE ALSO

       rdma_leave_multicast(3), rdma_bind_addr(3), rdma_resolve_addr(3), rdma_create_qp(3), rdma_get_cm_event(3)

librdmacm							    2008-01-02						    RDMA_JOIN_MULTICAST(3)