1cosTime(3)                 Erlang Module Definition                 cosTime(3)
2
3
4

NAME

6       cosTime - The main module of the cosTime application
7

DESCRIPTION

9       To get access to the record definitions for the structures use:
10       -include_lib("cosTime/include/*.hrl").
11
12       This module contains the functions for starting and stopping the appli‐
13       cation.
14
15       This application use the time base 15 october  1582  00:00.  Performing
16       operations using other time bases will not yield correct result.
17
18       The  OMG  CosTime  specification  defines  the operation secure_univer‐
19       sal_time. As of today we cannot provide this functionality  considering
20       the criteria demanded to fulfill the OMG specification.
21
22       When  using  this application, time and inaccuracy supplied by the user
23       must be given in number of 100 nano seconds. The Time Displacement Fac‐
24       tor is positive east of the meridian, while those to the west are nega‐
25       tive.
26
27       This application use calender:now_to_universal_time(Now)  to  create  a
28       UTC.  Hence, the underlying OS must deliver a correct result when call‐
29       ing erlang:now().
30
31       When determining the inaccuracy of the system, the user should consider
32       the  way the time objects will be used. Communicating with other ORB's,
33       add a substantial overhead and should be taken into consideration.
34

EXPORTS

36       install_time() -> Return
37
38              Types:
39
40                 Return = ok | {'EXIT', Reason}
41
42              This operation installs the cosTime Time Service  part  applica‐
43              tion.
44
45       uninstall_time() -> Return
46
47              Types:
48
49                 Return = ok | {'EXIT', Reason}
50
51              This operation uninstalls the cosTime Time Service part applica‐
52              tion.
53
54       install_timerevent() -> Return
55
56              Types:
57
58                 Return = ok | {'EXIT', Reason}
59
60              This operation installs the cosTime Timer Event Service part ap‐
61              plication.
62
63          Note:
64              The  Timer Event Service part requires Time Service part and co‐
65              sEvent or the cosNotification application to be installed first.
66
67
68       uninstall_timerevent() -> Return
69
70              Types:
71
72                 Return = ok | {'EXIT', Reason}
73
74              This operation uninstalls the cosTime Timer Event  Service  part
75              application.
76
77       start() -> Return
78
79              Types:
80
81                 Return = ok | {error, Reason}
82
83              This operation starts the cosTime application.
84
85       stop() -> Return
86
87              Types:
88
89                 Return = ok | {error, Reason}
90
91              This operation stops the cosTime application.
92
93       start_time_service(Tdf, Inaccuracy) -> Return
94
95              Types:
96
97                 Tdf = short()
98                 Inaccuracy = ulonglong(), eq. #100 nano seconds
99                 Return = ok | {'EXCEPTION', #'BAD_PARAM'{}}
100
101              This  operation  starts  a Time Service server. Please note that
102              there may only be exactly one Time Service active at a time. The
103              Inaccuracy  parameter  defines  the inaccuracy the underlying OS
104              will introduce. Remember to take into account latency when pass‐
105              ing time object between nodes.
106
107       stop_time_service(TimeService) -> ok
108
109              Types:
110
111                 TimeService = #objref
112
113              This operation stops the Time Service object.
114
115       start_timerevent_service(TimeService) -> ok
116
117              Types:
118
119                 TimeService = #objref
120
121              This  operation starts a Timer Event Service server. Please note
122              that there may only be exactly one Timer Event Service per  node
123              active at a time. The supplied TimeServcie reference will be the
124              object Timer Event Service contacts to get access to a new UTC.
125
126       stop_timerevent_service(TimerEventService) -> ok
127
128              Types:
129
130                 TimerEventService = #objref
131
132              This operation stops the Timer Event Service object.
133
134
135
136Ericsson AB                      cosTime 5.0.1                      cosTime(3)