← Back to branch summary

~ubuntu-branches/ubuntu/utopic/libmodbus/utopic

« back to all changes in this revision

Viewing changes to doc/modbus_set_byte_timeout.3

  • Committer: Package Import Robot
  • Author(s): Ivo De Decker
  • Date: 2013-06-30 12:25:01 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20130630122501-13vkglrt4xzalz1p
Tags: 3.0.4-1
* New upstream release 
* Update standards-version to 3.9.4 (no changes) 
* Enable parallel build
* Enable verbose build to show compiler flags to build log checks 
* Update watch file to filter out unstable versions 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/modbus_set_byte_timeout.3
1
 
'\" t
2
 
.\"     Title: modbus_set_byte_timeout
3
 
.\"    Author: [see the "AUTHORS" section]
4
 
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5
 
.\"      Date: 05/26/2012
6
 
.\"    Manual: Libmodbus Manual
7
 
.\"    Source: libmodbus 3.0.3
8
 
.\"  Language: English
9
 
.\"
10
 
.TH "MODBUS_SET_BYTE_TIME" "3" "05/26/2012" "libmodbus 3\&.0\&.3" "Libmodbus Manual"
11
 
.\" -----------------------------------------------------------------
12
 
.\" * Define some portability stuff
13
 
.\" -----------------------------------------------------------------
14
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15
 
.\" http://bugs.debian.org/507673
16
 
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18
 
.ie \n(.g .ds Aq \(aq
19
 
.el       .ds Aq '
20
 
.\" -----------------------------------------------------------------
21
 
.\" * set default formatting
22
 
.\" -----------------------------------------------------------------
23
 
.\" disable hyphenation
24
 
.nh
25
 
.\" disable justification (adjust text to left margin only)
26
 
.ad l
27
 
.\" -----------------------------------------------------------------
28
 
.\" * MAIN CONTENT STARTS HERE *
29
 
.\" -----------------------------------------------------------------
30
 
.SH "NAME"
31
 
modbus_set_byte_timeout \- set timeout between bytes
32
 
.SH "SYNOPSIS"
33
 
.sp
34
 
\fBvoid modbus_set_byte_timeout(modbus_t *\fR\fB\fIctx\fR\fR\fB, struct timeval *\fR\fB\fItimeout\fR\fR\fB);\fR
35
 
.SH "DESCRIPTION"
36
 
.sp
37
 
The \fImodbus_set_byte_timeout()\fR function shall set the timeout interval between two consecutive bytes of the same message\&. If the delay between is longer than the given timeout, an error will be raised\&.
38
 
.sp
39
 
If the timeout value has a tv_sec of \-1 then this timeout will not be used at all\&. This results in modbus_set_response_timeout governing the entire timeout duration of an operation\&.
40
 
.SH "RETURN VALUE"
41
 
.sp
42
 
There is no return values\&.
43
 
.SH "SEE ALSO"
44
 
.sp
45
 
\fBmodbus_get_byte_timeout\fR(3) \fBmodbus_get_response_timeout\fR(3) \fBmodbus_set_response_timeout\fR(3)
46
 
.SH "AUTHORS"
47
 
.sp
48
 
The libmodbus documentation was written by St\('ephane Raimbault <\m[blue]\fBstephane\&.raimbault@gmail\&.com\fR\m[]\&\s-2\u[1]\d\s+2>
49
 
.SH "NOTES"
50
 
.IP " 1." 4
51
 
stephane.raimbault@gmail.com
52
 
.RS 4
53
 
\%mailto:stephane.raimbault@gmail.com
54
 
.RE