1dlpi_set_timeout(D3aDtLaPIL)ink Provider Interface Library Fundcltpiio_nsset_timeout(3DLPI)
2
3
4

NAME

6       dlpi_set_timeout - set DLPI handle timeout interval
7

SYNOPSIS

9       cc [ flag ... ] file ... -ldlpi [ library ... ]
10       #include <libdlpi.h>
11
12       int dlpi_set_timeout(dlpi_handle_t dh, int sec);
13
14

DESCRIPTION

16       The  dlpi_set_timeout()  function sets the timeout interval to sec sec‐
17       onds on DLPI handle dh. This timeout is used by libdlpi(3LIB) functions
18       that require explicit acknowledgment from the associated DLPI link, and
19       bounds the number of seconds that a function will wait for an  acknowl‐
20       edgment  before  returning DLPI_ETIMEDOUT. Except for dlpi_recv(3DLPI),
21       which has a timeout argument, any function that is documented to return
22       DLPI_ETIMEDOUT can take up to the timeout interval to complete.
23
24
25       Callers  that  do  not  require an upper bound on timeouts are strongly
26       encouraged to never call dlpi_set_timeout(), and allow libdlpi  to  use
27       its  default  timeout  value.  The default timeout value is intended to
28       ensure that DLPI_ETIMEDOUT will only be returned if the DLPI  link  has
29       truly  become  unresponsive.  The  default timeout value is intended to
30       ensure that DLPI_ETIMEDOUT will be returned only if the DLPI  link  has
31       truly become unresponsive.
32
33
34       Callers  that do require an explicit upper bound can specify that value
35       at any time by calling dlpi_set_timeout().  However, note  that  values
36       less than 5 seconds may trigger spurious failures on certain DLPI links
37       and systems under high load, and thus are discouraged. Attempts to  set
38       the timeout value to less than 1 second will fail.
39
40
41       If  sec  is  set  to  DLPI_DEF_TIMEOUT,  the  default  timeout value is
42       restored.
43

RETURN VALUES

45       Upon success, DLPI_SUCCESS is returned. Otherwise, a DLPI  error  value
46       is returned.
47

ERRORS

49       DLPI_EINHANDLE    Invalid DLPI handle
50
51

ATTRIBUTES

53       See attributes(5) for description of the following attributes:
54
55
56
57
58       ┌─────────────────────────────┬─────────────────────────────┐
59       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
60       ├─────────────────────────────┼─────────────────────────────┤
61       │Interface Stability          │Committed                    │
62       ├─────────────────────────────┼─────────────────────────────┤
63       │MT-Level                     │Safe                         │
64       └─────────────────────────────┴─────────────────────────────┘
65

SEE ALSO

67       libdlpi(3LIB), attributes(5)
68
69
70
71SunOS 5.11                        21 Aug 2007          dlpi_set_timeout(3DLPI)
Impressum