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
|
.TH cosTime 3 "cosTime 1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
cosTime \- The main module of the cosTime application
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosTime/include/*\&.hrl")\&.\fR
.LP
This module contains the functions for starting and stopping the application\&.
.LP
This application use the time base \fI15 october 1582 00:00\fR\&. Performing operations using other time bases will not yield correct result\&.
.LP
The OMG CosTime specification defines the operation \fIsecure_universal_time\fR\&. As of today we cannot provide this functionality considering the criteria demanded to fulfill the OMG specification\&.
.LP
When using this application, time and inaccuracy supplied by the user must be given in number of \fI100 nano seconds\fR\&. The \fITime Displacement Factor\fR is positive east of the meridian, while those to the west are negative\&.
.LP
This application use \fIcalender:now_to_universal_time(Now)\fR to create a UTC\&. Hence, the underlying OS must deliver a correct result when calling \fIerlang:now()\fR\&.
.LP
When determining the inaccuracy of the system, the user should consider the way the time objects will be used\&. Communicating with other ORB\&'s, add a substantial overhead and should be taken into consideration\&.
.SH EXPORTS
.LP
.B
install_time() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXIT\&', Reason}
.br
.RE
.RS
.LP
This operation installs the cosTime Time Service part application\&.
.RE
.LP
.B
uninstall_time() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXIT\&', Reason}
.br
.RE
.RS
.LP
This operation uninstalls the cosTime Time Service part application\&.
.RE
.LP
.B
install_timerevent() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXIT\&', Reason}
.br
.RE
.RS
.LP
This operation installs the cosTime Timer Event Service part application\&.
.SS Note:
.LP
The Timer Event Service part requires \fITime Service\fR part and \fIcosEvent\fR or the \fIcosNotification\fR application to be installed first\&.
.RE
.LP
.B
uninstall_timerevent() -> Return
.br
.RS
.TP
Types
Return = ok | {\&'EXIT\&', Reason}
.br
.RE
.RS
.LP
This operation uninstalls the cosTime Timer Event Service part application\&.
.RE
.LP
.B
start() -> Return
.br
.RS
.TP
Types
Return = ok | {error, Reason}
.br
.RE
.RS
.LP
This operation starts the cosTime application\&.
.RE
.LP
.B
stop() -> Return
.br
.RS
.TP
Types
Return = ok | {error, Reason}
.br
.RE
.RS
.LP
This operation stops the cosTime application\&.
.RE
.LP
.B
start_time_service(Tdf, Inaccuracy) -> Return
.br
.RS
.TP
Types
Tdf = short()
.br
Inaccuracy = ulonglong(), eq\&. #100 nano seconds
.br
Return = ok | {\&'EXCEPTION\&', #\&'BAD_PARAM\&'{}}
.br
.RE
.RS
.LP
This operation starts a Time Service server\&. Please note that there may only be exactly one Time Service active at a time\&. The \fIInaccuracy\fR parameter defines the inaccuracy the underlying OS will introduce\&. Remember to take into account latency when passing time object between nodes\&.
.RE
.LP
.B
stop_time_service(TimeService) -> ok
.br
.RS
.TP
Types
TimeService = #objref
.br
.RE
.RS
.LP
This operation stops the Time Service object\&.
.RE
.LP
.B
start_timerevent_service(TimeService) -> ok
.br
.RS
.TP
Types
TimeService = #objref
.br
.RE
.RS
.LP
This operation starts a Timer Event Service server\&. Please note that there may only be exactly one Timer Event Service per node active at a time\&. The supplied TimeServcie reference will be the object Timer Event Service contacts to get access to a new UTC\&.
.RE
.LP
.B
stop_timerevent_service(TimerEventService) -> ok
.br
.RS
.TP
Types
TimerEventService = #objref
.br
.RE
.RS
.LP
This operation stops the Timer Event Service object\&.
.RE
|
