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

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_STATUS 3  "May 17, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_status \- get the status of a umad buffer
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_status(void " "*umad" );
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_status()
  14 get the internal
  15 .I umad\fR
  16 status field.
  17 .SH "RETURN VALUE"
  18 After a packet is received,
  19 .B umad_status()
  20 returns 0 on a successful receive, or a non zero status.
  21 ETIMEDOUT means that the packet had
  22 a send-timeout indication. In this case, the transaction ID will be
  23 set to the TID of the original request.
  24 .SH "AUTHOR"
  25 .TP
  26 Hal Rosenstock <halr@voltaire.com>