contrib/ofed/management/libibumad/man/umad_send.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_SEND 3  "May 11, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_send \- send umad
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_send(int " "portid" ", int " "agentid" ", void " "*umad" ", int " "timeout_ms" ", int " "retries");
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_send()
  14 sends the specified
  15 .I umad\fR
  16 buffer from the port specified by
  17 .I portid\fR,
  18 and using the agent specified by
  19 .I agentid\fR.
  20 .I timeout_ms\fR
  21 controls the solicited MADs behavior as follows:
  22 zero value means not solicited. Positive value makes kernel indicate timeout
  23 in milliseconds. If reply is not received within the specified value, the
  24 original buffer is returned in the read channel with the status field set (to
  25 non zero). Negative
  26 .I timeout_ms\fR
  27 makes kernel wait forever for the reply.
  28 .I retries\fR
  29 indicates the number of times the MAD will be retried before giving up.
  30 .SH "RETURN VALUE"
  31 .B umad_send()
  32 returns 0 on success, and a negative value on error as follows:
  33  -EINVAL invalid port handle or agentid
  34  -EIO    send operation failed
  35 .SH "AUTHOR"
  36 .TP
  37 Hal Rosenstock <halr@voltaire.com>