aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cosTime/doc/src/cosTime.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/cosTime/doc/src/cosTime.xml')
-rw-r--r--lib/cosTime/doc/src/cosTime.xml174
1 files changed, 174 insertions, 0 deletions
diff --git a/lib/cosTime/doc/src/cosTime.xml b/lib/cosTime/doc/src/cosTime.xml
new file mode 100644
index 0000000000..8bc80f2322
--- /dev/null
+++ b/lib/cosTime/doc/src/cosTime.xml
@@ -0,0 +1,174 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2000</year>
+ <year>2007</year>
+ <holder>Ericsson AB, All Rights Reserved</holder>
+ </copyright>
+ <legalnotice>
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
+
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
+
+ The Initial Developer of the Original Code is Ericsson AB.
+ </legalnotice>
+
+ <title>cosTime</title>
+ <prepared>Niclas Eklund</prepared>
+ <responsible>Niclas Eklund</responsible>
+ <docno></docno>
+ <approved>Niclas Eklund</approved>
+ <checked></checked>
+ <date>2000-01-31</date>
+ <rev>PA1</rev>
+ </header>
+ <module>cosTime</module>
+ <modulesummary>The main module of the cosTime application</modulesummary>
+ <description>
+ <p>To get access to the record definitions for the structures use: <br></br>
+<c>-include_lib("cosTime/include/*.hrl").</c></p>
+ <p>This module contains the functions for starting and stopping the application.</p>
+ <p>This application use the time base <em>15 october 1582 00:00</em>.
+ Performing operations using other time bases will not yield correct result.</p>
+ <p>The OMG CosTime specification defines the operation
+ <c>secure_universal_time</c>. As of today we cannot provide this functionality
+ considering the criteria demanded to fulfill the OMG specification.</p>
+ <p>When using this application, time and inaccuracy supplied by the user must
+ be given in number of <em>100 nano seconds</em>. The
+ <em>Time Displacement Factor</em> is positive east of the meridian, while
+ those to the west are negative.</p>
+ <p>This application use <c>calender:now_to_universal_time(Now)</c> to create a
+ UTC. Hence, the underlying OS must deliver a correct result when calling
+ <c>erlang:now()</c>.</p>
+ <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.</p>
+ </description>
+ <funcs>
+ <func>
+ <name>install_time() -> Return</name>
+ <fsummary>Install the cosTime Time Service part application</fsummary>
+ <type>
+ <v>Return = ok | {'EXIT', Reason}</v>
+ </type>
+ <desc>
+ <p>This operation installs the cosTime Time Service part application.</p>
+ </desc>
+ </func>
+ <func>
+ <name>uninstall_time() -> Return</name>
+ <fsummary>Uninstall the cosTime Time Service part application</fsummary>
+ <type>
+ <v>Return = ok | {'EXIT', Reason}</v>
+ </type>
+ <desc>
+ <p>This operation uninstalls the cosTime Time Service part application.</p>
+ </desc>
+ </func>
+ <func>
+ <name>install_timerevent() -> Return</name>
+ <fsummary>Install the cosTime Timer Event Service part application</fsummary>
+ <type>
+ <v>Return = ok | {'EXIT', Reason}</v>
+ </type>
+ <desc>
+ <p>This operation installs the cosTime Timer Event Service part application.</p>
+ <note>
+ <p>The Timer Event Service part requires <em>Time Service</em> part and
+ <em>cosEvent</em> or the <em>cosNotification</em> application to be installed
+ first.</p>
+ </note>
+ </desc>
+ </func>
+ <func>
+ <name>uninstall_timerevent() -> Return</name>
+ <fsummary>Uninstall the cosTime Timer Event Service part application</fsummary>
+ <type>
+ <v>Return = ok | {'EXIT', Reason}</v>
+ </type>
+ <desc>
+ <p>This operation uninstalls the cosTime Timer Event Service part application.</p>
+ </desc>
+ </func>
+ <func>
+ <name>start() -> Return</name>
+ <fsummary>Start the cosTime application</fsummary>
+ <type>
+ <v>Return = ok | {error, Reason}</v>
+ </type>
+ <desc>
+ <p>This operation starts the cosTime application.</p>
+ </desc>
+ </func>
+ <func>
+ <name>stop() -> Return</name>
+ <fsummary>Stop the cosTime application</fsummary>
+ <type>
+ <v>Return = ok | {error, Reason}</v>
+ </type>
+ <desc>
+ <p>This operation stops the cosTime application.</p>
+ </desc>
+ </func>
+ <func>
+ <name>start_time_service(Tdf, Inaccuracy) -> Return</name>
+ <fsummary>Start a Time Service object</fsummary>
+ <type>
+ <v>Tdf = short()</v>
+ <v>Inaccuracy = ulonglong(), eq. #100 nano seconds</v>
+ <v>Return = ok | {'EXCEPTION', #'BAD_PARAM'{}}</v>
+ </type>
+ <desc>
+ <p>This operation starts a Time Service server. Please note that there
+ may only be exactly one Time Service active at a time. The <c>Inaccuracy</c>
+ parameter defines the inaccuracy the underlying OS will introduce. Remember
+ to take into account latency when passing time object between nodes.</p>
+ </desc>
+ </func>
+ <func>
+ <name>stop_time_service(TimeService) -> ok</name>
+ <fsummary>Stop the target Time Service object</fsummary>
+ <type>
+ <v>TimeService = #objref</v>
+ </type>
+ <desc>
+ <p>This operation stops the Time Service object.</p>
+ </desc>
+ </func>
+ <func>
+ <name>start_timerevent_service(TimeService) -> ok</name>
+ <fsummary>Start a Timer Event Service object</fsummary>
+ <type>
+ <v>TimeService = #objref</v>
+ </type>
+ <desc>
+ <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.</p>
+ </desc>
+ </func>
+ <func>
+ <name>stop_timerevent_service(TimerEventService) -> ok</name>
+ <fsummary>Stop the target Timer Event Service object</fsummary>
+ <type>
+ <v>TimerEventService = #objref</v>
+ </type>
+ <desc>
+ <p>This operation stops the Timer Event Service object.</p>
+ </desc>
+ </func>
+ </funcs>
+
+</erlref>
+