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