From 90acd08f35f9691753fdd523c6970365b6ea4b73 Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Fri, 19 Dec 2014 01:24:53 +0000
Subject: Doc fix
---
doc/libftrigr.html | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
(limited to 'doc/libftrigr.html')
diff --git a/doc/libftrigr.html b/doc/libftrigr.html
index 27ffd61..79c7694 100644
--- a/doc/libftrigr.html
+++ b/doc/libftrigr.html
@@ -76,7 +76,7 @@ for instance, illustrate how to use the ftrigr library.
- Synchronous functions take a tain_t const *
(deadline) parameter and a tain_t * (stamp)
-parameter. Those are pointers to taia structures containing absolute times;
+parameter. Those are pointers to tain_t structures containing absolute times;
the former represents a deadline (in most cases, this time will be in the
future) and the latter must be an accurate enough timestamp. These
structures can be filled using the tain_ primitives declared in
@@ -85,13 +85,13 @@ structures can be filled using the tain_ primitives declared in
been made since the last time stamp was updated (by
tain_now(&stamp)). It's a good policy to always update
stamp right after a (potentially) blocking system call like
-select()returns. And unless the application is extremely CPU-intensive
+select() returns. And unless the application is extremely CPU-intensive
(think calculus for physicists or astronomers) updating stamp more
frequently is unnecessary.)
- If such a synchronous function still hasn't returned when the deadline
occurs, then it will immediately return a failure code and set errno to ETIMEDOUT.
It is possible to pass null pointers to the function instead of pointers to
-taia structures, in which case the function will never timeout.
+tain_t structures, in which case the function will never timeout.
- If a timeout occurs, the library does not guarantee proper interprocess
communication later on; the application should either die, or at least close
the communication channel and open a new one.
@@ -114,10 +114,10 @@ control on.
ftrigr_t a = FTRIGR_ZERO ;
-struct taia deadline, stamp ;
+tain_t deadline, stamp ;
-taia_now(&stamp) ;
-taia_addsec(&deadline, &stamp, 2)
+tain_now(&stamp) ;
+tain_addsec(&deadline, &stamp, 2)
// char const *path = FTRIGR_IPCPATH ;
// ftrigr_start(&a, path, &deadline, &stamp) ;
@@ -231,7 +231,7 @@ of usage examples.)
-int ftrigr_fd (struct ftrigr const *a)
+int ftrigr_fd (ftrigr_t const *a)
@@ -240,7 +240,7 @@ int ftrigr_fd (struct ftrigr const *a)
-int ftrigr_update (ftrigr_ref a)
+int ftrigr_update (ftrigr_t *a)
@@ -260,7 +260,7 @@ integers. Those integers are ids waiting to be passed to
-int ftrigr_check (ftrigr_ref a, uint16 id, char *what)
+int ftrigr_check (ftrigr_t *a, uint16 id, char *what)
--
cgit v1.2.3