File: ticablelinkcable.put.txt

package info (click to toggle)
libticables3 3.9.6-10
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 3,656 kB
  • ctags: 2,184
  • sloc: ansic: 15,996; sh: 9,298; makefile: 526; yacc: 288; awk: 145; sed: 16
file content (25 lines) | stat: -rw-r--r-- 671 bytes parent folder | download | duplicates (3) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
[Main]
Name=put
Type=Function
Header=cabl_int.h
Definition=int (*put) (@uint8_t@ data);

[Parameters]
data : the byte to send.
Returns : 0 if successful, an error code otherwise.

[Summary]
Send a byte over the cable.

[Description]
The function attempts to send a byte. It's blocking but it the time is over the timeout value, the function returns with an error code.

Timeout value can be changed at any time with the @ticable_set_timeout@ function.

When function returns, it typically returns:
<br>- either ERR_WRITE_ERROR : system error,
<br>- either ERR_WRITE_TIMEOUT : timed out.

[See also]
Error codes are listed in cabl_err.h.
The @TicableLinkCable@ structure.