contrib/ofed/librdmacm/man/rdma_reject.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_REJECT" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_reject \- Called to reject a connection request.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_reject
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "const void *" private_data ","
  11 .BI "uint8_t " private_data_len ");"
  12 .SH ARGUMENTS
  13 .IP "id" 12
  14 Connection identifier associated with the request.
  15 .IP "private_data" 12
  16 Optional private data to send with the reject message.
  17 .IP "private_data_len" 12
  18 Specifies the size of the user-controlled data buffer.  Note that the actual
  19 amount of data transferred to the remote side is transport dependent and may
  20 be larger than that requested.
  21 .SH "DESCRIPTION"
  22 Called from the listening side to reject a connection or datagram
  23 service lookup request.
  24 .SH "RETURN VALUE"
  25 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  26 set to indicate the failure reason.
  27 .SH "NOTES"
  28 After receiving a connection request event, a user may call rdma_reject
  29 to reject the request.  If the underlying RDMA transport supports
  30 private data in the reject message, the specified data will be passed to
  31 the remote side.
  32 .SH "SEE ALSO"
  33 rdma_listen(3), rdma_accept(3), rdma_get_cm_event(3)