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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
<TITLE>cosTime</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>cosTime</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
cosTime
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
The main module of the cosTime application
</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>
<P> This module contains the functions for starting and stopping the application.
<P> This application use the time base <STRONG>15 october 1582 00:00</STRONG>.
Performing operations using other time bases will not yield correct result.
<P> The OMG CosTime specification defines the operation
<CODE>secure_universal_time</CODE>. As of today we cannot provide this functionality
considering the criteria demanded to fulfill the OMG specification.
<P> When using this application, time and inaccuracy supplied by the user must
be given in number of <STRONG>100 nano seconds</STRONG>. The
<STRONG>Time Displacement Factor</STRONG> is positive east of the meridian, while
those to the west are negative.
<P> This application use <CODE>calender:now_to_universal_time(Now)</CODE> to create a
UTC. Hence, the underlying OS must deliver a correct result when calling
<CODE>erlang:now()</CODE>.
<P> 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.
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="install_time/0"><STRONG><CODE>install_time() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation installs the cosTime Time Service part application.
</DIV>
<P><A NAME="uninstall_time/0"><STRONG><CODE>uninstall_time() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation uninstalls the cosTime Time Service part application.
</DIV>
<P><A NAME="install_timerevent/0"><STRONG><CODE>install_timerevent() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation installs the cosTime Timer Event Service part application.
<P>
<TABLE CELLPADDING=4>
<TR>
<TD VALIGN=TOP><IMG ALT="Note!" SRC="note.gif"></TD>
<TD>
<P>The Timer Event Service part requires <STRONG>Time Service</STRONG> part and
<STRONG>cosEvent</STRONG> or the <STRONG>cosNotification</STRONG> application to be installed
first. </TD>
</TR>
</TABLE>
</DIV>
<P><A NAME="uninstall_timerevent/0"><STRONG><CODE>uninstall_timerevent() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXIT', Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation uninstalls the cosTime Timer Event Service part application.
</DIV>
<P><A NAME="start/0"><STRONG><CODE>start() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation starts the cosTime application.
</DIV>
<P><A NAME="stop/0"><STRONG><CODE>stop() -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation stops the cosTime application.
</DIV>
<P><A NAME="start_time_service/2"><STRONG><CODE>start_time_service(Tdf, Inaccuracy) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Tdf = short()</CODE></STRONG><BR>
<STRONG><CODE>Inaccuracy = ulonglong(), eq. #100 nano seconds</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', #'BAD_PARAM'{}}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation starts a Time Service server. Please note that there
may only be exactly one Time Service active at a time. The <CODE>Inaccuracy</CODE>
parameter defines the inaccuracy the underlying OS will introduce. Remember
to take into account latency when passing time object between nodes.
</DIV>
<P><A NAME="stop_time_service/1"><STRONG><CODE>stop_time_service(TimeService) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation stops the Time Service object.
</DIV>
<P><A NAME="start_timerevent_service/1"><STRONG><CODE>start_timerevent_service(TimeService) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> 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.
</DIV>
<P><A NAME="stop_timerevent_service/1"><STRONG><CODE>stop_timerevent_service(TimerEventService) -> ok</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimerEventService = #objref</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation stops the Timer Event Service object.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Support - 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>
|
