umad_poll(3) — Linux manual page

UMAD_POLL(3)           OpenIB Programmer's Manual           UMAD_POLL(3)

NAME

       umad_poll - poll umad

SYNOPSIS

       #include <infiniband/umad.h>

       int umad_poll(int portid, int timeout_ms);

DESCRIPTION

       umad_poll() waits up to timeout_ms milliseconds for a packet to
       be received from the port specified by portid.  Once a packet is
       ready to be read, the function returns 0. After that the packet
       can be read using umad_recv().  Otherwise, -ETIMEDOUT is
       returned. Note that successfully polling a port does not
       guarantee that the subsequent umad_recv() will be non blocking
       when several threads are using the same port. Instead, use a
       timeout_ms parameter of zero to umad_recv() to ensure a non-
       blocking read.

RETURN VALUE

       umad_poll() returns 0 on success, and a negative value on error
       as follows:
        -EINVAL    invalid port handle or agentid
        -ETIMEDOUT poll operation timed out
        -EIO       poll operation failed

SEE ALSO

       umad_recv(3)

AUTHOR

       Hal Rosenstock <halr@voltaire.com>

COLOPHON

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       linux-rdma@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2024-06-14.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2024-06-10.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

OpenIB                      October 23, 2007                UMAD_POLL(3)

Pages that refer to this page: umad_recv(3)

---