Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_timeout (3)

Name

ares_timeout - return maximum time to wait

Synopsis

#include <ares.h>

struct timeval *ares_timeout(ares_channel channel,
struct timeval *maxtv,
struct timeval *tv)

Description

ARES_TIMEOUT(3)            Library Functions Manual            ARES_TIMEOUT(3)



NAME
       ares_timeout - return maximum time to wait

SYNOPSIS
       #include <ares.h>

       struct timeval *ares_timeout(ares_channel channel,
                                    struct timeval *maxtv,
                                    struct timeval *tv)

DESCRIPTION
       The  ares_timeout(3) function determines the maximum time for which the
       caller should wait before invoking ares_process(3) to process timeouts.
       The  parameter  maxtv  specifies a existing maximum timeout, or NULL if
       the caller does not wish to apply a maximum timeout.  The parameter  tv
       must  point to a writable buffer of type struct timeval It is valid for
       maxtv and tv to have the same value.

       If no queries have timeouts pending sooner than the given maximum time-
       out,  ares_timeout(3)  returns the value of maxtv; otherwise ares_time-
       out(3) stores the appropriate timeout value into the buffer pointed  to
       by tv and returns the value of tv.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libcares |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       ares_fds(3), ares_process(3), ares_process_fd(3)

AUTHOR
       Greg Hudson, MIT Information Systems
       Copyright 1998 by the Massachusetts Institute of Technology.



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://c-ares.haxx.se/download/c-
       ares-1.17.2.tar.gz.

       Further information about this software can be found on the open source
       community website at https://c-ares.haxx.se/.



                                 25 July 1998                  ARES_TIMEOUT(3)