File: CosTimerEvent_TimerEventService.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (62 lines) | stat: -rw-r--r-- 1,302 bytes parent folder | download
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
.TH CosTimerEvent_TimerEventService 3 "cosTime  1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosTimerEvent_TimerEventService \- This module implements the OMG CosTimerEvent::TimerEventService interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use: 
.br
\fI-include_lib("cosTime/include/*\&.hrl")\&.\fR

.SH EXPORTS
.LP
.B
register(TimerEventService, CosEventCommPushConsumer, Data) -> TimerEventHandler
.br
.RS
.TP
Types
TimerEventService = CosEventCommPushConsumer = TimerEventHandler = #objref
.br
Data = #any
.br
.RE
.RS
.LP
This operation will create a new \fITimerEventHandler\fR object which will push given \fIData\fR to given \fICosEventCommPushConsumer\fR after the timer have been set\&.
.RE
.LP
.B
unregister(TimerEventService, TimerEventHandler) -> ok
.br
.RS
.TP
Types
TimerEventService = TimerEventHandler = #objref
.br
.RE
.RS
.LP
This operation will terminate the given TimerEventHandler\&.
.RE
.LP
.B
event_time(TimerEventService, TimerEvent) -> UTO
.br
.RS
.TP
Types
TimerEventService = #objref
.br
TimerEvent = #\&'CosTimerEvent_TimerEvent\&'{utc, event_data}
.br
utc = 
.br
event_data = #any}
.br
UTO = #objref
.br
.RE
.RS
.LP
This operation returns a UTO containing the time at which the associated event was triggered\&.
.RE