freebsd-skq/contrib/ofed/librdmacm/man/rdma_bind_addr.3
hselasky c1872221d7 OFED user-space import and update for use with Linux-4.9 compatible RDMA
kernel APIs.

List of sources used:

1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git"
Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75

2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git
Top commit 85f841cf209f791c89a075048a907020e924528d

3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git"
Tag 1.3.13 with some additional patches from Mellanox.

4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git"
Tag 1.6.7 with some additional patches from Mellanox.

Added the required Makefiles for building and installing.

Sponsored by:	Mellanox Technologies
2017-08-02 16:00:30 +00:00

34 lines
1.3 KiB
Groff

.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.TH "RDMA_BIND_ADDR" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
.SH NAME
rdma_bind_addr \- Bind an RDMA identifier to a source address.
.SH SYNOPSIS
.B "#include <rdma/rdma_cma.h>"
.P
.B "int" rdma_bind_addr
.BI "(struct rdma_cm_id *" id ","
.BI "struct sockaddr *" addr ");"
.SH ARGUMENTS
.IP "id" 12
RDMA identifier.
.IP "addr" 12
Local address information. Wildcard values are permitted.
.SH "DESCRIPTION"
Associates a source address with an rdma_cm_id. The address may be
wildcarded. If binding to a specific local address, the rdma_cm_id
will also be bound to a local RDMA device.
.SH "RETURN VALUE"
Returns 0 on success, or -1 on error. If an error occurs, errno will be
set to indicate the failure reason.
.SH "NOTES"
Typically, this routine is called before calling rdma_listen to bind
to a specific port number, but it may also be called on the active side
of a connection before calling rdma_resolve_addr to bind to a specific
address.
.P
If used to bind to port 0, the rdma_cm will select an available port,
which can be retrieved with rdma_get_src_port(3).
.SH "SEE ALSO"
rdma_create_id(3), rdma_listen(3), rdma_resolve_addr(3), rdma_create_qp(3),
rdma_get_local_addr(3), rdma_get_src_port(3)