summaryrefslogtreecommitdiffstats
path: root/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md
diff options
context:
space:
mode:
authorgrowupboron <shankhoghosh123@gmail.com>2020-10-09 00:19:18 +0530
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-10-14 11:19:53 +0000
commiteefc3ab6cbb8a5901632f46d99e13c8d90b2415d (patch)
tree90815d532ed7b2d0962a1468aee29f05a4404eef /docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md
parent4aad369c9728061c97b3de792286e743ee884b09 (diff)
rewrote quickstart, build-process
Revamped and updated documentation to install and build AGL images. (removed whitespaces, added contribution guide, corrected rcar-gen3 section 7, added aglsetup.h flags to hardware support, some minor changes) Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: Iedb6c7dc1661f4bc58b5f25ea5d188778c7ff908 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25407 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md')
-rw-r--r--docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md57
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md b/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md
deleted file mode 100644
index 65d805f..0000000
--- a/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.2_AFB_Timer.md
+++ /dev/null
@@ -1,57 +0,0 @@
----
-edit_link: ''
-title: AFB Timer
-origin_url: >-
- https://git.automotivelinux.org/src/libafb-helpers/plain/docs/afb-timer.md?h=master
----
-
-<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/afb-helpers-function-references-afb-helpers-book.yml -->
-
-# AFB Timer functions reference
-
-## TimerHandleT
-
-Members are:
-
-* `count`: integer representing the number of times the timers should run.
-* `delay`: millisecond integer representing the delay to wait before and between
- the callback run.
-* `uid`: a string identifying the timer.
-* `context`: an opaq pointer that could be used in the callback function.
-* `evtSource`: a systemd event source struct. Should be NULL.
-* `api`: the AFB api pointer.
-* `callback`: a function pointer for the callback to call at timer expiration
-* `freeCB`: a function pointer called after expiration of the timer. Mainly meant
- to release the context pointer by example.
-
-## void TimerEvtStart(afb_api_t api, TimerHandleT *timerHandle, timerCallbackT callback, void *context)
-
-Start a timer which invokes the callback when the delay expires for `count`
-times.
-
-* `api`: AFB api pointer.
-* `timerHandle`: pointer to struct representing a timer.
-* `callback`: a function pointer for the callback to call at timer expiration
-* `context`: an opaq pointer that could be used in the callback function.
-
-## void TimerEvtStop(TimerHandleT *timerHandle)
-
-Manually stop the timer's run. If the `count` isn't finished then it will end
-the timer and no other runs will occur.
-
-* `timerHandle`: pointer to struct representing a timer.
-
-## uint64_t LockWait(afb_api_t api, uint64_t utimeout)
-
-It is function acting like a non-blocking sleep for an API. It lets the main API
-event loop runs while you are waiting and will unlock at the first received
-event and returns the remaining time to wait if an event occurs or 0 if no events
-occured and timeout hits. Then you have to manually ensure that once an event
-has been received that it was the one you are waiting for and if not launch again
-the wait with the remaining time returned.
-
-* `api`: AFB api pointer.
-* `timeout`: timeout in microsecond.
-
-Returns the remaining time in microsecond to wait if an event occurs or 0 if no
-events occured and timeout hits