1 09/13/82  timed_io_
 2 
 3 Function: performs I/O operations which must complete within a
 4 specified time interval.  The user should be familiar with the use of
 5 the subroutine iox_.
 6 
 7 Each entry point documented here has an argument denoting the
 8 particular I/O switch involved in the operation, and an argument whose
 9 value is the duration of the period the caller is willing to wait for
10 the completion of the I/O operation, in microseconds.
11 
12 
13 Entry points in timed_io_:
14    (List is generated by the help command)
15 
16 
17 :Entry:  get_chars:  09/13/82 timed_io_$get_chars
18 
19 Function: performs the function of iox_$get_chars; if the operation
20 does not complete within the specified time interval, the error code
21 error_table_$timeout is returned to the caller.
22 
23 
24 Syntax:
25 declare timed_io_$get_chars entry (ptr, fixed bin (71), ptr,
26      fixed bin (21), fixed bin (21), fixed bin (35));
27 call timed_io_$get_chars (iocb_ptr, timeout, buff_ptr, n, n_read, code);
28 
29 
30 Arguments:
31 iocb_ptr, buff_ptr, n, n_read, and code are as described in the iox_
32      documentation.
33 timeout
34      is the period in microseconds during which the caller is willing
35      to wait for the completion of the get_chars call.
36 
37 
38 :Entry:  get_line:  09/13/82 timed_io_$get_line
39 
40 Function: performs the function of iox_$get_line; if the operation
41 does not complete within the specified time interval, the error code
42 error_table_$timeout is returned to the caller.
43 
44 
45 Syntax:
46 declare timed_io_$get_line entry (ptr, fixed bin (71), ptr,
47      fixed bin (21), fixed bin (21), fixed bin (35));
48 call timed_io_$get_line (iocb_ptr, timeout, buff_ptr, buff_len, n_read, code);
49 
50 
51 Arguments:
52 iocb_ptr, buff_ptr, buff_len, n_read, and code are as described in the iox_
53      documentation.
54 timeout
55      is the period in microseconds during which the caller is willing
56      to wait for the completion of the get_line call.
57 
58 
59 :Entry:  put_chars:  09/13/82 timed_io_$put_chars
60 
61 
62 Function: performs the function of iox_$put_chars; if the operation
63 does not complete within the specified time interval, the error code
64 error_table_$timeout is returned to the caller.
65 
66 
67 Syntax:
68 declare timed_io_$put_chars entry (ptr, fixed bin (71), ptr,
69      fixed bin (21), fixed bin (21), fixed bin (35));
70 call timed_io_$put_chars (iocb_ptr, timeout, buff_ptr, n, n_written, code);
71 
72 
73 Arguments:
74 iocb_ptr, buff_ptr, n, and code are as described in the iox_
75      documentation.
76 timeout
77      is the period in microseconds during which the caller is willing
78      to wait for the completion of the put_chars call.
79 n_written
80      is the number of characters actually written to the switch before
81      the timeout period expired.