| Message ID | 1450446594-30963-1-git-send-email-ivan.khoronzhuk@linaro.org |
|---|---|
| State | New |
| Headers | show |
On 18 December 2015 at 08:49, Ivan Khoronzhuk <ivan.khoronzhuk@linaro.org> wrote: > Signed-off-by: Ivan Khoronzhuk <ivan.khoronzhuk@linaro.org> > --- > doc/users-guide/users-guide.adoc | 15 ++++++++++++++- > 1 file changed, 14 insertions(+), 1 deletion(-) > > diff --git a/doc/users-guide/users-guide.adoc > b/doc/users-guide/users-guide.adoc > index 7ec7957..d2b5480 100644 > --- a/doc/users-guide/users-guide.adoc > +++ b/doc/users-guide/users-guide.adoc > @@ -197,7 +197,7 @@ precise syntax and semantics of each API. > ODP programs are built around several conceptual structures that every > application programmer needs to be familiar with to use ODP effectively. > The > main ODP concepts are: > -Thread, Event, Queue, Pool, Shared Memory, Buffer, Packet, PktIO, Timer, > +Thread, Event, Queue, Pool, Shared Memory, Buffer, Packet, PktIO, Time, > Timer, > and Synchronizer. > > === Thread > @@ -305,6 +305,19 @@ or may represent a device attached via a PCIE or > other bus. > > PktIOs are represented by handles of abstract type +odp_pktio_t+. > > +=== Time > +The time API is used to measure time intervals and track time flow of an > +application and duplicated > presents presents missing "a" > convenient way to get access to time source. > +The time API consists replace > from with "of " > two main parts: local time API and global time API. > bullet the section * Local time > +The local time API is supposed to be used within one thread and can be > faster > +then global time API. The local time API cannot be used between threads > as time > +consistency is not guaranteed, and in some cases that's enough. subheading the section * Local time > The global time > +API is supposed to be used for tracking time between threads. Both local > and > +global time is not wrapped during application life cycle. The time API > includes > highlight the functions and use their actual name use for example +sum()+ and +diff()+ +functions to operate with time, such as sum, diff, resolution, wait. > +The odp_time_t highlight the actual type + odp_time_t+ opaque type represents or local or global timestamp, the > +responsibility is on a user to use time operations with appropriate time > type. > + > === Timer > Timers are how ODP applications measure and respond to the passage of > time. > Timers are drawn from specialized pools called timer pools that have their > -- > 1.9.1 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 7ec7957..d2b5480 100644 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -197,7 +197,7 @@ precise syntax and semantics of each API. ODP programs are built around several conceptual structures that every application programmer needs to be familiar with to use ODP effectively. The main ODP concepts are: -Thread, Event, Queue, Pool, Shared Memory, Buffer, Packet, PktIO, Timer, +Thread, Event, Queue, Pool, Shared Memory, Buffer, Packet, PktIO, Time, Timer, and Synchronizer. === Thread @@ -305,6 +305,19 @@ or may represent a device attached via a PCIE or other bus. PktIOs are represented by handles of abstract type +odp_pktio_t+. +=== Time +The time API is used to measure time intervals and track time flow of an +application and presents presents convenient way to get access to time source. +The time API consists from two main parts: local time API and global time API. +The local time API is supposed to be used within one thread and can be faster +then global time API. The local time API cannot be used between threads as time +consistency is not guaranteed, and in some cases that's enough. The global time +API is supposed to be used for tracking time between threads. Both local and +global time is not wrapped during application life cycle. The time API includes +functions to operate with time, such as sum, diff, resolution, wait. +The odp_time_t opaque type represents or local or global timestamp, the +responsibility is on a user to use time operations with appropriate time type. + === Timer Timers are how ODP applications measure and respond to the passage of time. Timers are drawn from specialized pools called timer pools that have their
Signed-off-by: Ivan Khoronzhuk <ivan.khoronzhuk@linaro.org> --- doc/users-guide/users-guide.adoc | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-)