1CosTimerEvent_TimerEventHandElrelra(n3g)Module DefiCnoistTiiomnerEvent_TimerEventHandler(3)
2
3
4

NAME

6       CosTimerEvent_TimerEventHandler  - This module implements the OMG  Cos‐
7       TimerEvent::TimerEventHandler interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosTime/include/*.hrl").
12

EXPORTS

14       '_get_status'(TimerEventHandler) -> Reply
15
16              Types:
17
18                 TimerEventHandler = #objref
19                 Reply = 'ESTimeSet' | 'ESTimeCleared' | 'ESTriggered' |  'ES‐
20                 FailedTrigger'
21
22              This operation returns the status of the target object.
23
24                * 'ESTimeSet' - timer is set to trigger event(s).
25
26                * 'ESTimeCleared' - no time set or the timer have been reset.
27
28                * 'ESTriggered' - event has already been sent.
29
30                * 'ESFailedTrigger' - tried to, but failed, sending the event.
31
32              If  the  target  object is of type 'TTPeriodic' the status value
33              'ESTriggered' is not valid.
34
35       time_set(TimerEventHandler) -> Reply
36
37              Types:
38
39                 TimerEventHandler = #objref
40                 Reply = {boolean(), UTO}
41                 UTO = #objref
42
43              This operation returns true if the time  has  been  set  for  an
44              event  that  is yet to be triggered, false otherwise. The outpa‐
45              rameter represents the current time value of the target object.
46
47       set_timer(TimerEventHandler, TimeType, TriggerTime) -> void()
48
49              Types:
50
51                 TimerEventHandler = #objref
52                 TimeType = 'TTAbsolute' | 'TTRelative' | 'TTPeriodic'
53                 TriggerTime = UTO
54                 UTO = #objref
55
56              This operation terminates any previous set trigger,  and  set  a
57              new trigger specified by the TimeType and UTO objects.
58
59              The relation between the UTO object and the TimeTypes are:
60
61                * 'TTAbsolute'  - the UTO object must represent absolute time,
62                  i.e., number of 100 nanoseconds passed since 15 october 1582
63                  00:00.
64
65                * 'TTRelative'  -  the  UTO object must represent the from now
66                  until when the  event  should  be  triggered,  e.g.,  within
67                  30*10^7 nanoseconds.
68
69                * 'TTPeriodic' - the same as for 'TTRelative', but this option
70                  will trigger an event periodically until timer cancelled.
71
72       cancel_timer(TimerEventHandler) -> boolean()
73
74              Types:
75
76                 TimerEventHandler = #objref
77
78              This operation cancel, if possible, the triggering of  event(s).
79              Returns true if an event is actually cancelled, false otherwise.
80
81       set_data(TimerEventHandler, EventData) -> ok
82
83              Types:
84
85                 TimerEventHandler = #objref
86                 EventData = #any
87
88              This operation changes the event data sent when triggered.
89
90
91
92Ericsson AB                      cosTime 5.0.C1osTimerEvent_TimerEventHandler(3)