1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
<TITLE>CosTimerEvent_TimerEventHandler</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>CosTimerEvent_TimerEventHandler</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosTimerEvent_TimerEventHandler
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG
CosTimerEvent::TimerEventHandler interface.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> To get access to the record definitions for the structures use:<BR>
<CODE>-include_lib("cosTime/include/*.hrl").</CODE>
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="'_get_status'/1"><STRONG><CODE>'_get_status'(TimerEventHandler) -> Reply</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventHandler = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = 'ESTimeSet' | 'ESTimeCleared' | 'ESTriggered' | 'ESFailedTrigger'</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation returns the status of the target object.
<P>
<UL>
<LI>
'ESTimeSet' - timer is set to trigger event(s).
</LI>
<LI>
'ESTimeCleared' - no time set or the timer have been reset.
</LI>
<LI>
'ESTriggered' - event has already been sent.
</LI>
<LI>
'ESFailedTrigger' - tried to, but failed, sending the event.
</LI>
</UL>
<P>If the target object is of type 'TTPeriodic' the status value
'ESTriggered' is not valid.
</DIV>
<P><A NAME="time_set/1"><STRONG><CODE>time_set(TimerEventHandler) -> Reply</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventHandler = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = {boolean(), UTO}</CODE></STRONG><BR>
<STRONG><CODE>UTO = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation returns <CODE>true</CODE> if the time has been set for an event that
is yet to be triggered, <CODE>false</CODE> otherwise. The outparameter represents
the current time value of the target object.
</DIV>
<P><A NAME="set_timer/3"><STRONG><CODE>set_timer(TimerEventHandler, TimeType, TriggerTime) -> void()</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventHandler = #objref</CODE></STRONG><BR>
<STRONG><CODE>TimeType = 'TTAbsolute' | 'TTRelative' | 'TTPeriodic'</CODE></STRONG><BR>
<STRONG><CODE>TriggerTime = UTO</CODE></STRONG><BR>
<STRONG><CODE>UTO = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation terminates any previous set trigger, and set a new trigger
specified by the <CODE>TimeType</CODE> and <CODE>UTO</CODE> objects.
<P> The relation between the UTO object and the TimeTypes are:
<P>
<UL>
<LI>
'TTAbsolute' - the UTO object must represent absolute time, i.e.,
number of 100 nanoseconds passed since 15 october
1582 00:00.
</LI>
<LI>
'TTRelative' - the UTO object must represent the from now until when
the event should be triggered, e.g., within 30*10^7 nanoseconds.
</LI>
<LI>
'TTPeriodic' - the same as for 'TTRelative', but this option
will trigger an event periodically until timer cancelled.
</LI>
</UL>
</DIV>
<P><A NAME="cancel_timer/1"><STRONG><CODE>cancel_timer(TimerEventHandler) -> boolean()</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventHandler = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation cancel, if possible, the triggering of event(s). Returns
<CODE>true</CODE> if an event is actually cancelled, <CODE>false</CODE> otherwise.
</DIV>
<P><A NAME="set_data/2"><STRONG><CODE>set_data(TimerEventHandler, EventData) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventHandler = #objref</CODE></STRONG><BR>
<STRONG><CODE>EventData = #any</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation changes the event data sent when triggered.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Niclas Eklund - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>cosTime 1.1<BR>
Copyright © 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
