rdma_join_multicast(3) [centos man page]

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)

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

NAME

       rdma_resolve_addr - Resolve destination and optional source addresses.

SYNOPSIS

       #include <rdma/rdma_cma.h>

       int rdma_resolve_addr (struct rdma_cm_id *id, struct sockaddr *src_addr, struct sockaddr *dst_addr, int timeout_ms);

ARGUMENTS

       id	   RDMA identifier.

       src_addr    Source address information.	This parameter may be NULL.

       dst_addr    Destination address information.

       timeout_ms  Time to wait for resolution to complete.

DESCRIPTION

       Resolve	destination  and  optional source addresses from IP addresses to an RDMA address.  If successful, the specified rdma_cm_id will be
       bound to a local device.

RETURN VALUE

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

NOTES

       This call is used to map a given destination IP address to a usable RDMA address.  The IP to RDMA address mapping is done using	the  local
       routing	tables,  or  via  ARP.	 If a source address is given, the rdma_cm_id is bound to that address, the same as if rdma_bind_addr were
       called.	If no source address is given, and the rdma_cm_id has not yet been bound to a device, then the	rdma_cm_id  will  be  bound  to  a
       source address based on the local routing tables.  After this call, the rdma_cm_id will be bound to an RDMA device.  This call is typically
       made from the active side of a connection before calling rdma_resolve_route and rdma_connect.

INFINIBAND SPECIFIC

       This call maps the destination and, if given, source IP addresses to GIDs.  In order to perform the mapping, IPoIB must be running on  both
       the local and remote nodes.

SEE ALSO

       rdma_create_id(3),      rdma_resolve_route(3),	  rdma_connect(3),     rdma_create_qp(3),     rdma_get_cm_event(3),	rdma_bind_addr(3),
       rdma_get_src_port(3), rdma_get_dst_port(3), rdma_get_local_addr(3), rdma_get_peer_addr(3)

librdmacm							    2007-10-31						      RDMA_RESOLVE_ADDR(3)