1
<?xml version="1.0" encoding="latin1" ?>
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
9
<holder>Ericsson AB, All Rights Reserved</holder>
12
The contents of this file are subject to the Erlang Public License,
13
Version 1.1, (the "License"); you may not use this file except in
14
compliance with the License. You should have received a copy of the
15
Erlang Public License along with this software. If not, it can be
16
retrieved online at http://www.erlang.org/.
18
Software distributed under the License is distributed on an "AS IS"
19
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
20
the License for the specific language governing rights and limitations
23
The Initial Developer of the Original Code is Ericsson AB.
26
<title>CosTimerEvent_­TimerEventHandler</title>
27
<shorttitle>..._TimerEventHandler</shorttitle>
28
<prepared>Niclas Eklund</prepared>
29
<responsible>Niclas Eklund</responsible>
31
<approved>Niclas Eklund</approved>
33
<date>2000-02-01</date>
36
<module>CosTimerEvent_TimerEventHandler</module>
37
<modulesummary>This module implements the OMG CosTimerEvent::TimerEventHandler interface.</modulesummary>
39
<p>To get access to the record definitions for the structures use: <br></br>
40
<c>-include_lib("cosTime/include/*.hrl").</c></p>
44
<name>'_get_status'(TimerEventHandler) -> Reply</name>
45
<fsummary>Return the status of the target object</fsummary>
47
<v>TimerEventHandler = #objref</v>
48
<v>Reply = 'ESTimeSet' | 'ESTimeCleared' | 'ESTriggered' | 'ESFailedTrigger'</v>
51
<p>This operation returns the status of the target object. </p>
52
<list type="bulleted">
53
<item>'ESTimeSet' - timer is set to trigger event(s).</item>
54
<item>'ESTimeCleared' - no time set or the timer have been reset.</item>
55
<item>'ESTriggered' - event has already been sent.</item>
56
<item>'ESFailedTrigger' - tried to, but failed, sending the event.</item>
58
<p>If the target object is of type 'TTPeriodic' the status value
59
'ESTriggered' is not valid.</p>
63
<name>time_set(TimerEventHandler) -> Reply</name>
64
<fsummary>Return <c>true</c>if the time has been set for an event that is yet to be triggered, <c>false</c>otherwise. The outparameter represents the current time value of the target object</fsummary>
66
<v>TimerEventHandler = #objref</v>
67
<v>Reply = {boolean(), UTO}</v>
71
<p>This operation returns <c>true</c> if the time has been set for an event that
72
is yet to be triggered, <c>false</c> otherwise. The outparameter represents
73
the current time value of the target object.</p>
77
<name>set_timer(TimerEventHandler, TimeType, TriggerTime) -> void()</name>
78
<fsummary>Terminate terminate any previous set trigger, and set a new trigger specified by the <c>TimeType</c>and <c>UTO</c>objects</fsummary>
80
<v>TimerEventHandler = #objref</v>
81
<v>TimeType = 'TTAbsolute' | 'TTRelative' | 'TTPeriodic'</v>
82
<v>TriggerTime = UTO</v>
86
<p>This operation terminates any previous set trigger, and set a new trigger
87
specified by the <c>TimeType</c> and <c>UTO</c> objects.</p>
88
<p>The relation between the UTO object and the TimeTypes are:</p>
89
<list type="bulleted">
90
<item>'TTAbsolute' - the UTO object must represent absolute time, i.e.,
91
number of 100 nanoseconds passed since 15 october
93
<item>'TTRelative' - the UTO object must represent the from now until when
94
the event should be triggered, e.g., within 30*10^7 nanoseconds.</item>
95
<item>'TTPeriodic' - the same as for 'TTRelative', but this option
96
will trigger an event periodically until timer cancelled.</item>
101
<name>cancel_timer(TimerEventHandler) -> boolean()</name>
102
<fsummary>Cancel, if possible, triggering of event(s). Return<c>true</c>if an event is actually cancelled, <c>false</c>otherwise</fsummary>
104
<v>TimerEventHandler = #objref</v>
107
<p>This operation cancel, if possible, the triggering of event(s). Returns
108
<c>true</c> if an event is actually cancelled, <c>false</c> otherwise.</p>
112
<name>set_data(TimerEventHandler, EventData) -> ok</name>
113
<fsummary>Change the event data sent when triggered</fsummary>
115
<v>TimerEventHandler = #objref</v>
116
<v>EventData = #any</v>
119
<p>This operation changes the event data sent when triggered.</p>