aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ose/doc/src/ose_erl_driver.xml
diff options
context:
space:
mode:
authorJonas Karlsson <[email protected]>2014-02-21 14:01:38 +0100
committerLukas Larsson <[email protected]>2014-02-24 15:16:08 +0100
commit4a6850e522b91eb009ddd0ed9d9f542f1baf1bee (patch)
treef87fa607ccb90bb3d36020826800c2ff8946948c /lib/ose/doc/src/ose_erl_driver.xml
parentad9d36c55fb6c77ce0a6163e009313deaa2d2bb0 (diff)
downloadotp-4a6850e522b91eb009ddd0ed9d9f542f1baf1bee.tar.gz
otp-4a6850e522b91eb009ddd0ed9d9f542f1baf1bee.tar.bz2
otp-4a6850e522b91eb009ddd0ed9d9f542f1baf1bee.zip
ose: Updating event and signal API for OSE
Diffstat (limited to 'lib/ose/doc/src/ose_erl_driver.xml')
-rw-r--r--lib/ose/doc/src/ose_erl_driver.xml9
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/ose/doc/src/ose_erl_driver.xml b/lib/ose/doc/src/ose_erl_driver.xml
index 93cbd91be7..1d89d7aeea 100644
--- a/lib/ose/doc/src/ose_erl_driver.xml
+++ b/lib/ose/doc/src/ose_erl_driver.xml
@@ -68,12 +68,13 @@
</desc>
</func>
<func>
- <name><ret>ErlDrvEvent</ret><nametext>erl_drv_ose_event_alloc(SIGSELECT signo, ErlDrvOseEventId id, ErlDrvOseEventId (*resolve_signal)(union SIGNAL* sig))</nametext></name>
+ <name><ret>ErlDrvEvent</ret><nametext>erl_drv_ose_event_alloc(SIGSELECT signo, ErlDrvOseEventId id, ErlDrvOseEventId (*resolve_signal)(union SIGNAL* sig), void *extra)</nametext></name>
<desc>
<marker id="erl_drv_ose_event_alloc"></marker>
<p>Create a new <c>ErlDrvEvent</c> associated with <c>signo</c>,
<c>id</c> and uses the <c>resolve_signal</c> function to extract
- the <c>id</c> from a signal with <c>signo</c>. See
+ the <c>id</c> from a signal with <c>signo</c>. The <c>extra</c>
+ parameter can be used for additional data. See
<seealso marker="ose_signals_chapter#driver">
Signals in a Linked-in driver</seealso> in the OSE User's Guide.
</p>
@@ -89,10 +90,10 @@
</desc>
</func>
<func>
- <name><ret>void</ret><nametext>erl_drv_ose_event_fetch(ErlDrvEvent drv_event, SIGSELECT *signo, int *id)</nametext></name>
+ <name><ret>void</ret><nametext>erl_drv_ose_event_fetch(ErlDrvEvent drv_event, SIGSELECT *signo, ErlDrvOseEventId *id, void **extra)</nametext></name>
<desc>
<marker id="erl_drv_ose_event_fetch"></marker>
- <p>Write the signal number and id associated with <c>drv_event</c>
+ <p>Write the signal number, id and any extra data associated with <c>drv_event</c>
into <c>*signo</c> and <c>*id</c> respectively. <c>NULL</c> can be
also passed as <c>signo</c> or <c>id</c> in order to ignore that field.
</p>