From 6bcdad20c24457393c0d9eeb385d0ff5aa872cd0 Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Wed, 25 Apr 2018 15:09:14 +0200 Subject: Move the corba applcations to separate repository All corba applications are moved to a separate repository. E.g. orber, ic, cosEvent, cosEventDomain, cosNotifications cosTime, cosTransactions, cosProperty and cosFileTransfer. --- lib/cosTime/doc/html/.gitignore | 0 lib/cosTime/doc/man3/.gitignore | 0 lib/cosTime/doc/man6/.gitignore | 0 lib/cosTime/doc/pdf/.gitignore | 0 lib/cosTime/doc/src/CosTime_TIO.xml | 109 ------- lib/cosTime/doc/src/CosTime_TimeService.xml | 104 ------ lib/cosTime/doc/src/CosTime_UTO.xml | 156 --------- .../doc/src/CosTimerEvent_TimerEventHandler.xml | 125 ------- .../doc/src/CosTimerEvent_TimerEventService.xml | 84 ----- lib/cosTime/doc/src/Makefile | 138 -------- lib/cosTime/doc/src/book.xml | 49 --- lib/cosTime/doc/src/ch_contents.xml | 75 ----- lib/cosTime/doc/src/ch_example.xml | 113 ------- lib/cosTime/doc/src/ch_install.xml | 56 ---- lib/cosTime/doc/src/ch_introduction.xml | 59 ---- lib/cosTime/doc/src/cosTime.xml | 175 ---------- lib/cosTime/doc/src/notes.xml | 360 --------------------- lib/cosTime/doc/src/part.xml | 40 --- lib/cosTime/doc/src/ref_man.xml | 42 --- 19 files changed, 1685 deletions(-) delete mode 100644 lib/cosTime/doc/html/.gitignore delete mode 100644 lib/cosTime/doc/man3/.gitignore delete mode 100644 lib/cosTime/doc/man6/.gitignore delete mode 100644 lib/cosTime/doc/pdf/.gitignore delete mode 100644 lib/cosTime/doc/src/CosTime_TIO.xml delete mode 100644 lib/cosTime/doc/src/CosTime_TimeService.xml delete mode 100644 lib/cosTime/doc/src/CosTime_UTO.xml delete mode 100644 lib/cosTime/doc/src/CosTimerEvent_TimerEventHandler.xml delete mode 100644 lib/cosTime/doc/src/CosTimerEvent_TimerEventService.xml delete mode 100644 lib/cosTime/doc/src/Makefile delete mode 100644 lib/cosTime/doc/src/book.xml delete mode 100644 lib/cosTime/doc/src/ch_contents.xml delete mode 100644 lib/cosTime/doc/src/ch_example.xml delete mode 100644 lib/cosTime/doc/src/ch_install.xml delete mode 100644 lib/cosTime/doc/src/ch_introduction.xml delete mode 100644 lib/cosTime/doc/src/cosTime.xml delete mode 100644 lib/cosTime/doc/src/notes.xml delete mode 100644 lib/cosTime/doc/src/part.xml delete mode 100644 lib/cosTime/doc/src/ref_man.xml (limited to 'lib/cosTime/doc') diff --git a/lib/cosTime/doc/html/.gitignore b/lib/cosTime/doc/html/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/lib/cosTime/doc/man3/.gitignore b/lib/cosTime/doc/man3/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/lib/cosTime/doc/man6/.gitignore b/lib/cosTime/doc/man6/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/lib/cosTime/doc/pdf/.gitignore b/lib/cosTime/doc/pdf/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/lib/cosTime/doc/src/CosTime_TIO.xml b/lib/cosTime/doc/src/CosTime_TIO.xml deleted file mode 100644 index c01154a2c5..0000000000 --- a/lib/cosTime/doc/src/CosTime_TIO.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - CosTime_TIO - Niclas Eklund - Niclas Eklund - - Niclas Eklund - - 2000-02-01 - 1.0 -
- CosTime_TIO - This module implements the OMG CosTime::TIO interface. - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-
- - - '_get_time_interval'(TIO) -> TimeInterval - Return the interval associated with the target object - - TIO = #objref - TimeInterval = #'TimeBase_IntervalT{lower_bound, upper_bound} - lower_bound = upper_bound = ulonglong - - -

This operation returns the interval associated with the target object.

-
-
- - spans(TIO, UTO) -> Reply - Return an OverlapType which describe how the interval in the target object and the timerange represented by the UTO object overlap - - TIO = UTO = OtherTIO = #objref - Reply = {OverlapType, OtherTIO} - OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap' - - -

This operation returns a OverlapType depending on how the interval - in the target object and the timerange represented by the UTO object - overlap. If the OverlapType is 'OTNoOverlap' the out parameter represents - the gap between the two intervals. If OverlapType is one of the others, the - out parameter represents the overlap interval. - The definitions of the OverlapType's are:

-

- - 'OTContainer' - target objects lower and upper limits are, - respectively, less or equal to and greater or equal to given object's. - 'OTContained' - target objects lower and upper limits are, - respectively, greater or equal to and less or equal to given object's. - 'OTOverlap' - target objects interval overlap given object's. - 'OTNoOverlap' - target objects interval do not overlap given object's. - -
-
- - overlaps(TIO, OtherTIO) -> Reply - Return an OverlapType which describe how the interval in the target object and the timerange represented by the TIO object overlap - - TIO = OtherTIO = AnotherTIO = #objref - Reply = {OverlapType, AnotherTIO} - OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap' - - -

This operation returns a OverlapType depending on how the interval - in the target object and the timerange represented by the TIO object - overlap. The OverlapType's are described under spans/2.

-
-
- - time(TIO) -> UTO - Return a UTO in which the interval equals the time interval in the target object and time value is the midpoint of the interval - - TIO = UTO = #objref - - -

This operation returns a UTO in which the interval equals the time interval - in the target object and time value is the midpoint of the interval.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/CosTime_TimeService.xml b/lib/cosTime/doc/src/CosTime_TimeService.xml deleted file mode 100644 index b578128277..0000000000 --- a/lib/cosTime/doc/src/CosTime_TimeService.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - CosTime_TimeService - Niclas Eklund - Niclas Eklund - - Niclas Eklund - - 2000-02-01 - 1.0 -
- CosTime_TimeService - This module implements the OMG CosTime::TimeService interface. - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-
- - - universal_time(TimeService) -> Reply - Return the current time and the Inaccuracy given when starting this application in a UTO - - TimeService = #objref - Reply = UTO | {'EXCEPTION", #'TimerService_TimeUnavailable'{}} - UTO = #objref - - -

This operation returns the current time and the Inaccuracy given - when starting this application in a UTO. The time base is - 15 october 1582 00:00. Comparing two time objects which use - different time base is, by obvious reasons, pointless.

-
-
- - new_universal_time(TimeService, Time, Inaccuracy, Tdf) -> UTO - Create a new UTO object representing the time parameters given - - TimeService = UTO = #objref - Time = Inaccuracy = ulonglong() - Tdf = short() - - -

This operation creates a new UTO object representing the time - parameters given. This is the only way to create a UTO with an - arbitrary time from its components. This is useful when using the - Timer Event Service.

-
-
- - uto_from_utc(TimeService, Utc) -> UTO - Create a UTO representing the given time in Utc form - - TimeService = UTO = #objref - Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf} - time = ulonglong() - inacclo = ulong() - inacchi = ushort() - tdf = short() - - -

This operation is used to create a UTO given a time in the Utc form.

-
-
- - new_interval(TimeService, Lower, Upper) -> TIO - Create a new TIO object representing the input parameters - - TimeService = TIO = #objref - Lower = Upper = ulonglong() - - -

This operation is used to create a new TIO object, representing - the input parameters. If Lower is greater than Upper - BAD_PARAM is raised.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/CosTime_UTO.xml b/lib/cosTime/doc/src/CosTime_UTO.xml deleted file mode 100644 index 432d9d92f9..0000000000 --- a/lib/cosTime/doc/src/CosTime_UTO.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - CosTime_UTO - Niclas Eklund - Niclas Eklund - - Niclas Eklund - - 2000-02-01 - 1.0 -
- CosTime_UTO - This module implements the OMG CosTime::UTO interface. - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-
- - - '_get_time'(UTO) -> ulonglong() - Return the time associated with the target object - - UTO = #objref - - -

This operation returns the time associated with the target object.

-
-
- - '_get_inaccuracy'(UTO) -> ulonglong() - Return the inaccuracy associated with the target object - - UTO = #objref - - -

This operation returns the inaccuracy associated with the target object.

-
-
- - '_get_tdf'(UTO) -> short() - Return the time displacement factor associated with the target object - - UTO = #objref - - -

This operation returns the time displacement factor associated with - the target object.

-
-
- - '_get_utc_time'(UTO) -> UtcT - Return the data associated with the target object in Utc form - - UTO = #objref - Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf} - time = ulonglong() - inacclo = ulong() - inacchi = ushort() - tdf = short() - - -

This operation returns the data associated with the target object in - Utc form.

-
-
- - absolute_time(UTO) -> OtherUTO - Create a new UTO object representing the time in the target object added to current time (UTC) - - UTO = OtherUTO = #objref - - -

This operation create a new UTO object representing the time in the target - object added to current time (UTC). The time base is - 15 october 1582 00:00. Comparing two time objects which use - different time base is, by obvious reasons, pointless. - Raises DATA_CONVERSION if causes an overflow. This operation is only useful - if the target object represents a relative time.

-
-
- - compare_time(UTO, ComparisonType, OtherUTO) -> Reply - Compare the time associated with the target object and the given UTO object - - UTO = OtherUTO = #objref - ComparisonType = 'IntervalC' | 'MidC' - Reply = 'TCEqualTo' | 'TCLessThan' | 'TCGreaterThan' | 'TCIndeterminate' - - -

This operation compares the time associated with the target object and the - given UTO object. The different ComparisonType are:

-

- - 'MidC' - only compare the time represented by each object. Furthermore, - the target object is always used as the first parameter in the - comparison, i.e., if the target object's time is larger - 'TCGreaterThan' will be returned. - 'IntervalC' - also takes the inaccuracy into consideration, i.e., - if the two objects interval overlaps 'TCIndeterminate' is returned, - otherwise the as for 'MidC'. - -
-
- - time_to_interval(UTO, OtherUTO) -> TIO - Create a TIO representing the interval between the target object and the given UTO midpoint times - - UTO = OtherUTO = TIO = #objref - - -

This operation returns a TIO representing the interval between the target - object and the given UTO midpoint times. The inaccuracy in the objects are - not taken into consideration.

-
-
- - interval(UTO) -> TIO - Create a TIO object representing the error interval around the time value represented by the target object - - UTO = TIO = #objref - - -

This operation creates a TIO object representing the error interval - around the time value represented by the target object, i.e., - TIO.upper_bound = UTO.time+UTO.inaccuracy and - TIO.lower_bound = UTO.time-UTO.inaccuracy.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/CosTimerEvent_TimerEventHandler.xml b/lib/cosTime/doc/src/CosTimerEvent_TimerEventHandler.xml deleted file mode 100644 index 4b43b0b12e..0000000000 --- a/lib/cosTime/doc/src/CosTimerEvent_TimerEventHandler.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - CosTimerEvent_TimerEventHandler - - - - Niclas Eklund - - 2000-02-01 - 1.0 -
- CosTimerEvent_TimerEventHandler - This module implements the OMG CosTimerEvent::TimerEventHandler interface. - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-
- - - '_get_status'(TimerEventHandler) -> Reply - Return the status of the target object - - TimerEventHandler = #objref - Reply = 'ESTimeSet' | 'ESTimeCleared' | 'ESTriggered' | 'ESFailedTrigger' - - -

This operation returns the status of the target object.

- - 'ESTimeSet' - timer is set to trigger event(s). - 'ESTimeCleared' - no time set or the timer have been reset. - 'ESTriggered' - event has already been sent. - 'ESFailedTrigger' - tried to, but failed, sending the event. - -

If the target object is of type 'TTPeriodic' the status value - 'ESTriggered' is not valid.

-
-
- - time_set(TimerEventHandler) -> Reply - Return trueif the time has been set for an event that is yet to be triggered, falseotherwise. The outparameter represents the current time value of the target object - - TimerEventHandler = #objref - Reply = {boolean(), UTO} - UTO = #objref - - -

This operation returns true if the time has been set for an event that - is yet to be triggered, false otherwise. The outparameter represents - the current time value of the target object.

-
-
- - set_timer(TimerEventHandler, TimeType, TriggerTime) -> void() - Terminate terminate any previous set trigger, and set a new trigger specified by the TimeTypeand UTOobjects - - TimerEventHandler = #objref - TimeType = 'TTAbsolute' | 'TTRelative' | 'TTPeriodic' - TriggerTime = UTO - UTO = #objref - - -

This operation terminates any previous set trigger, and set a new trigger - specified by the TimeType and UTO objects.

-

The relation between the UTO object and the TimeTypes are:

- - 'TTAbsolute' - the UTO object must represent absolute time, i.e., - number of 100 nanoseconds passed since 15 october - 1582 00:00. - 'TTRelative' - the UTO object must represent the from now until when - the event should be triggered, e.g., within 30*10^7 nanoseconds. - 'TTPeriodic' - the same as for 'TTRelative', but this option - will trigger an event periodically until timer cancelled. - -
-
- - cancel_timer(TimerEventHandler) -> boolean() - Cancel, if possible, triggering of event(s). Returntrueif an event is actually cancelled, falseotherwise - - TimerEventHandler = #objref - - -

This operation cancel, if possible, the triggering of event(s). Returns - true if an event is actually cancelled, false otherwise.

-
-
- - set_data(TimerEventHandler, EventData) -> ok - Change the event data sent when triggered - - TimerEventHandler = #objref - EventData = #any - - -

This operation changes the event data sent when triggered.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/CosTimerEvent_TimerEventService.xml b/lib/cosTime/doc/src/CosTimerEvent_TimerEventService.xml deleted file mode 100644 index 1db4760c81..0000000000 --- a/lib/cosTime/doc/src/CosTimerEvent_TimerEventService.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - CosTimerEvent_TimerEventService - Niclas Eklund - Niclas Eklund - - Niclas Eklund - - 2000-02-01 - 1.0 -
- CosTimerEvent_TimerEventService - This module implements the OMG CosTimerEvent::TimerEventService interface. - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-
- - - register(TimerEventService, CosEventCommPushConsumer, Data) -> TimerEventHandler - Create a new TimerEventHandlerobject which push the givenDatato given CosEventCommPushConsumerafter the timer have been set - - TimerEventService = CosEventCommPushConsumer = TimerEventHandler = #objref - Data = #any - - -

This operation will create a new TimerEventHandler object which - will push given Data to given CosEventCommPushConsumer after - the timer have been set.

-
-
- - unregister(TimerEventService, TimerEventHandler) -> ok - Terminate the target TimerEventHandler object - - TimerEventService = TimerEventHandler = #objref - - -

This operation will terminate the given TimerEventHandler.

-
-
- - event_time(TimerEventService, TimerEvent) -> UTO - Return a UTO containing the time at which the associated event was triggered - - TimerEventService = #objref - TimerEvent = #'CosTimerEvent_TimerEvent'{utc, event_data} - utc = - event_data = #any} - UTO = #objref - - -

This operation returns a UTO containing the time at which the associated - event was triggered.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/Makefile b/lib/cosTime/doc/src/Makefile deleted file mode 100644 index 6886d2812c..0000000000 --- a/lib/cosTime/doc/src/Makefile +++ /dev/null @@ -1,138 +0,0 @@ -# -# %CopyrightBegin% -# -# Copyright Ericsson AB 2000-2017. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# %CopyrightEnd% -# -# -include $(ERL_TOP)/make/target.mk -include $(ERL_TOP)/make/$(TARGET)/otp.mk - -# ---------------------------------------------------- -# Application version -# ---------------------------------------------------- -include ../../vsn.mk -VSN=$(COSTIME_VSN) -APPLICATION=cosTime - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -XML_APPLICATION_FILES = ref_man.xml -XML_REF3_FILES = \ - cosTime.xml \ - CosTime_TIO.xml \ - CosTime_TimeService.xml \ - CosTime_UTO.xml \ - CosTimerEvent_TimerEventHandler.xml \ - CosTimerEvent_TimerEventService.xml \ - -XML_PART_FILES = \ - part.xml -XML_CHAPTER_FILES = \ - ch_contents.xml \ - ch_introduction.xml \ - ch_install.xml \ - ch_example.xml \ - notes.xml - -BOOK_FILES = book.xml - -XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ - $(XML_PART_FILES) $(XML_CHAPTER_FILES) - -TECHNICAL_DESCR_FILES = - -GIF_FILES = - -PS_FILES = - -# ---------------------------------------------------- - -INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) - -HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) - -INFO_FILE = ../../info -EXTRA_FILES = \ - $(DEFAULT_GIF_FILES) \ - $(DEFAULT_HTML_FILES) \ - $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) - -MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) - -HTML_REF_MAN_FILE = $(HTMLDIR)/index.html - -TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf - -# ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += -DVIPS_FLAGS += - -# ---------------------------------------------------- -# Targets -# ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ - -docs: pdf html man - -$(TOP_PDF_FILE): $(XML_FILES) - -pdf: $(TOP_PDF_FILE) - -html: gifs $(HTML_REF_MAN_FILE) - -clean clean_docs: - rm -rf $(HTMLDIR)/* - rm -f $(MAN3DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f errs core *~ - -man: $(MAN3_FILES) - -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) - -$(INDEX_TARGET): $(INDEX_SRC) - sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET) - -debug opt: - -# ---------------------------------------------------- -# Release Target -# ---------------------------------------------------- -include $(ERL_TOP)/make/otp_release_targets.mk - -release_docs_spec: docs - $(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DIR) "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(HTMLDIR)/* \ - "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" - $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" - -release_spec: diff --git a/lib/cosTime/doc/src/book.xml b/lib/cosTime/doc/src/book.xml deleted file mode 100644 index a89b005e84..0000000000 --- a/lib/cosTime/doc/src/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - cosTime - Niclas Eklund - - 2000-01-31 - 1.0 -
- - - cosTime - - - - - - - - - - - - - - -
- diff --git a/lib/cosTime/doc/src/ch_contents.xml b/lib/cosTime/doc/src/ch_contents.xml deleted file mode 100644 index 8b1c9dd646..0000000000 --- a/lib/cosTime/doc/src/ch_contents.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - The cosTime Application - Niclas Eklund - - 2000-01-31 - 1.0 - ch_contents.xml -
- -
- Content Overview -

The cosTime documentation is divided into three sections: -

- - -

PART ONE - The User's Guide -

-Description of the cosTime Application including - services and a small tutorial demonstrating - the development of a simple service.

-
- -

PART TWO - Release Notes -

-A concise history of cosTime.

-
- -

PART THREE - The Reference Manual -

- A quick reference guide, including a - brief description, to all the functions available in cosTime.

-
-
-
- -
- Brief Description of the User's Guide -

The User's Guide contains the following parts:

- - -

cosTime overview

-
- -

cosTime installation

-
- -

A tutorial example

-
-
-
-
- diff --git a/lib/cosTime/doc/src/ch_example.xml b/lib/cosTime/doc/src/ch_example.xml deleted file mode 100644 index 690fba8d93..0000000000 --- a/lib/cosTime/doc/src/ch_example.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - cosTime Examples - Niclas Eklund - - 2000-01-31 - A - ch_example.xml -
- -
- A Tutorial on How to Create a Simple Service - -
- Initiate the Application -

To use the complete cosTime application Time and Timer Event Services - must be installed. The application is then started by using - cosTime:start(). To get access to Time Service or Timer Event Service, - use start_time_service/2 or start_timerevent_service/1.

-

The Time Service are global, i.e., there may only exist one instance per - Orber domain.

-

The Timer Event Service is locally registered, i.e., there may only exist - one instance per node.

- -

The Time and Timer Event Service use the time base - 15 october 1582 00:00. Performing operations using other time - bases will not yield correct result. Furthermore, time and inaccuracy - must be expressed in 100 nano seconds.

-
-
- -
- How to Run Everything -

Below is a short transcript on how to run cosTime.

- - -%% Start Mnesia and Orber -mnesia:delete_schema([node()]), -mnesia:create_schema([node()]), -orber:install([node()]), -mnesia:start(), -orber:start(), - -%% Install Time Service in the IFR. -cosTime:install_time(), - -%% Install Timer Event Service in the IFR. Which, require -%% the Time Service and cosEvent or cosNotification -%% application to be installed. -cosNotification:install(), -cosTime:install_timerevent(), - -%% Now start the application and necessary services. -cosTime:start(), -%% Tdf == Time displacement factor -%% Inaccuracy measured in 100 nano seconds -TS=cosTime:start_time_service(TDF, Inaccuracy), -TES=cosTime:start_timerevent_service(TS), - -%% Access a cosNotification Proxy Push Consumer. How this is -%% done is implementation specific. -ProxyPushConsumer = .... - -%% How we construct the event is also implementation specific. -AnyEvent = .... - -%% Create a new relative universal time. -%% Time measured in 100 nano seconds. -UTO='CosTime_TimeService': - new_universal_time(TS, Time, Inaccuracy, TDF), -EH='CosTimerEvent_TimerEventService': - register(TES, ProxyPushConsumer, AnyEvent), - -%% If we want to trigger one event Time*10^-7 seconds from now: -'CosTimerEvent_TimerEventHandler':set_timer(EH, 'TTRelative', UTO), - -%% If we want to trigger an event every Time*10^-7 seconds, starting -%% Time*10^-7 seconds from now: -'CosTimerEvent_TimerEventHandler':set_timer(EH, 'TTPeriodic', UTO), - -%% If we want to use absolute time we must retrieve such an object. -%% One way is to convert the one we got, UTO, by using: -UTO2='CosTime_UTO':absolute_time(UTO), -%% If any other way is used, the correct time base MUST be used, i.e., -%% 15 october 1582 00:00. -'CosTimerEvent_TimerEventHandler':set_timer(EH, 'TTAbsolute', UTO2), - -
-
-
- diff --git a/lib/cosTime/doc/src/ch_install.xml b/lib/cosTime/doc/src/ch_install.xml deleted file mode 100644 index 9d819a7be7..0000000000 --- a/lib/cosTime/doc/src/ch_install.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - Installing cosTime - Niclas Eklund - - 2000-01-31 - - ch_install.xml -
- -
- Installation Process -

This chapter describes how to install - cosTime in an Erlang Environment. -

- -
- Preparation -

Before starting the installation process for cosTime, - the application Orber must be running.

-
- -
- Configuration -

When using both the Time and TimerEvent Services the cosTime application - first must be installed using cosTime:install_time() and - cosTime:install_timerevent(), followed by cosTime:start(). - Now we can choose which can start the servers by using - cosTime:start_time_service(Tdf, Inaccuracy) - and cosTime:start_timerevent_service(TimeService).

-
-
-
- diff --git a/lib/cosTime/doc/src/ch_introduction.xml b/lib/cosTime/doc/src/ch_introduction.xml deleted file mode 100644 index 1a11606716..0000000000 --- a/lib/cosTime/doc/src/ch_introduction.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - Introduction to cosTime - Niclas Eklund - - 2000-01-31 - - ch_introduction.xml -
- -
- Overview -

The cosTime application is Time and TimerEvent Services compliant with the OMG - Services CosTime and CosTimerEvent. -

- -
- Purpose and Dependencies -

This application use calender:now_to_universal_time(Now) to create a - UTC. Hence, the underlying OS must deliver a correct result when calling - erlang:now().

-

cosTime is dependent on Orber, which provides CORBA functionality in an Erlang environment.

-

cosTimerEvent is dependent on Orber and cosNotification, - which provides CORBA functionality and Event handling in an Erlang environment.

-
- -
- Prerequisites -

To fully understand the concepts presented in the - documentation, it is recommended that the user is familiar - with distributed programming, CORBA, the Orber and cosNotification applications. -

-

Recommended reading includes CORBA, Fundamentals and Programming - Jon Siegel and Open Telecom Platform Documentation Set. It is also helpful to have read Concurrent Programming in Erlang.

-
-
-
- diff --git a/lib/cosTime/doc/src/cosTime.xml b/lib/cosTime/doc/src/cosTime.xml deleted file mode 100644 index 02aef1401c..0000000000 --- a/lib/cosTime/doc/src/cosTime.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - -
- - 2000 - 2016 - Ericsson AB, All Rights Reserved - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - cosTime - Niclas Eklund - Niclas Eklund - - Niclas Eklund - - 2000-01-31 - PA1 -
- cosTime - The main module of the cosTime application - -

To get access to the record definitions for the structures use:

--include_lib("cosTime/include/*.hrl").

-

This module contains the functions for starting and stopping the application.

-

This application use the time base 15 october 1582 00:00. - Performing operations using other time bases will not yield correct result.

-

The OMG CosTime specification defines the operation - secure_universal_time. As of today we cannot provide this functionality - considering the criteria demanded to fulfill the OMG specification.

-

When using this application, time and inaccuracy supplied by the user must - be given in number of 100 nano seconds. The - Time Displacement Factor is positive east of the meridian, while - those to the west are negative.

-

This application use calender:now_to_universal_time(Now) to create a - UTC. Hence, the underlying OS must deliver a correct result when calling - erlang:now().

-

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.

-
- - - install_time() -> Return - Install the cosTime Time Service part application - - Return = ok | {'EXIT', Reason} - - -

This operation installs the cosTime Time Service part application.

-
-
- - uninstall_time() -> Return - Uninstall the cosTime Time Service part application - - Return = ok | {'EXIT', Reason} - - -

This operation uninstalls the cosTime Time Service part application.

-
-
- - install_timerevent() -> Return - Install the cosTime Timer Event Service part application - - Return = ok | {'EXIT', Reason} - - -

This operation installs the cosTime Timer Event Service part application.

- -

The Timer Event Service part requires Time Service part and - cosEvent or the cosNotification application to be installed - first.

-
-
-
- - uninstall_timerevent() -> Return - Uninstall the cosTime Timer Event Service part application - - Return = ok | {'EXIT', Reason} - - -

This operation uninstalls the cosTime Timer Event Service part application.

-
-
- - start() -> Return - Start the cosTime application - - Return = ok | {error, Reason} - - -

This operation starts the cosTime application.

-
-
- - stop() -> Return - Stop the cosTime application - - Return = ok | {error, Reason} - - -

This operation stops the cosTime application.

-
-
- - start_time_service(Tdf, Inaccuracy) -> Return - Start a Time Service object - - Tdf = short() - Inaccuracy = ulonglong(), eq. #100 nano seconds - Return = ok | {'EXCEPTION', #'BAD_PARAM'{}} - - -

This operation starts a Time Service server. Please note that there - may only be exactly one Time Service active at a time. The Inaccuracy - parameter defines the inaccuracy the underlying OS will introduce. Remember - to take into account latency when passing time object between nodes.

-
-
- - stop_time_service(TimeService) -> ok - Stop the target Time Service object - - TimeService = #objref - - -

This operation stops the Time Service object.

-
-
- - start_timerevent_service(TimeService) -> ok - Start a Timer Event Service object - - TimeService = #objref - - -

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.

-
-
- - stop_timerevent_service(TimerEventService) -> ok - Stop the target Timer Event Service object - - TimerEventService = #objref - - -

This operation stops the Timer Event Service object.

-
-
-
- -
- diff --git a/lib/cosTime/doc/src/notes.xml b/lib/cosTime/doc/src/notes.xml deleted file mode 100644 index 16e02f8b1f..0000000000 --- a/lib/cosTime/doc/src/notes.xml +++ /dev/null @@ -1,360 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - cosTime Release Notes - Niclas Eklund - Niclas Eklund - - - - 2000-01-31 - A - notes.xml -
- -
cosTime 1.2.3 - -
Fixed Bugs and Malfunctions - - -

Removed all old unused files in the documentation. -

-

- Own Id: OTP-14475 Aux Id: ERL-409, PR-1493

-
-
-
- -
- -
cosTime 1.2.2 - -
Improvements and New Features - - -

- Internal changes

-

- Own Id: OTP-13551

-
-
-
- -
- -
cosTime 1.2.1 - -
Improvements and New Features - - -

Suppress Dialyzer warnings.

-

- Own Id: OTP-12862

-
-
-
- -
- -
cosTime 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

-
-
-
- -
- -
cosTime 1.1.14 - -
Improvements and New Features - - -

The default encoding of Erlang files has been changed - from ISO-8859-1 to UTF-8.

The encoding of XML - files has also been changed to UTF-8.

-

- Own Id: OTP-10907

-
-
-
- -
- -
cosTime 1.1.13 - -
Improvements and New Features - - -

- Misc build updates

-

- Own Id: OTP-10784

-
-
-
- -
- -
cosTime 1.1.12 - -
Improvements and New Features - - -

Erlang/OTP can now be built using parallel make if you - limit the number of jobs, for instance using 'make - -j6' or 'make -j10'. 'make -j' does not - work at the moment because of some missing - dependencies.

-

- Own Id: OTP-9451

-
-
-
- -
- -
- cosTime 1.1.11 - -
- Improvements and New Features - - -

- Removed superfluous usage of shy in the documentation since it can cause problem if - a buggy tool is used.

-

- Own Id: OTP-9319 Aux Id:

-
-
-
-
- -
- cosTime 1.1.10 - -
- Improvements and New Features - - -

- Eliminated Dialyzer warnings when using exit or throw.

-

- Own Id: OTP-9050 Aux Id:

-
-
-
-
- -
- cosTime 1.1.9 - -
- Improvements and New Features - - -

- Test suites published.

-

- Own Id: OTP-8543 Aux Id:

-
-
-
-
- -
- cosTime 1.1.8 - -
- Fixed Bugs and Malfunctions - - -

The documentation EIX file was not generated.

-

Own id: OTP-8355 Aux Id:

-
-
-
-
- -
- cosTime 1.1.7 - -
- Improvements and New Features - - -

- The documentation is now built with open source tools (xsltproc and fop) - that exists on most platforms. One visible change is that the frames are removed.

-

- Own Id: OTP-8201 Aux Id:

-
-
-
-
- -
- cosTime 1.1.6 - -
- Improvements and New Features - - -

Obsolete guards, e.g. record vs is_record, has been changed - to avoid compiler warnings.

-

Own id: OTP-7987

-
-
-
-
- -
- cosTime 1.1.5 - -
- Improvements and New Features - - -

Updated file headers.

-

Own id: OTP-7837

-
-
-
-
- -
- cosTime 1.1.4 - -
- Improvements and New Features - - -

Documentation source included in open source releases.

-

Own id: OTP-7595

-
-
-
-
- -
- cosTime 1.1.3 - -
- Improvements and New Features - - -

Updated file headers.

-

Own id: OTP-7011

-
-
-
-
- -
- cosTime 1.1.2 - -
- Improvements and New Features - - -

The documentation source has been converted from SGML to XML.

-

Own id: OTP-6754

-
-
-
-
- -
- cosTime 1.1.1 - -
- Improvements and New Features - - -

Minor Makefile changes.

-

Own id: OTP-6701

-
-
-
-
- -
- cosTime 1.1 - -
- Improvements and New Features - - -

The stub/skeleton-files generated by IC have been improved, - i.e., depending on the IDL-files, reduced the size of the - erl- and beam-files and decreased dependencies off Orber's - Interface Repository. It is necessary to re-compile all IDL-files - and use COS-applications, including Orber, compiled with - IC-4.2.

-

Own id: OTP-4576

-
-
-
-
- -
- cosTime 1.0.1.1 - -
- Incompatibilities - - -

An includepath in CosTimerEvent.idl have been - changed. Hence, if you include this file you should check - your include paths for your IDL-file(s), i.e., add - the path to CosEventComm.idl.

-

Own Id: OTP-4093

-
-
-
-
- -
- cosTime 1.0.1 - -
- Improvements and New Features - - -

First release of the cosTime application.

-

Own Id: -

-
-
-
-
-
- diff --git a/lib/cosTime/doc/src/part.xml b/lib/cosTime/doc/src/part.xml deleted file mode 100644 index f0b26d4a56..0000000000 --- a/lib/cosTime/doc/src/part.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - cosTime User's Guide - Niclas Eklund - - 2000-01-31 - 1.0 -
- -

The cosTime application is an Erlang implementation of the OMG - CORBA Time and TimerEvent Services.

-
- - - - -
- diff --git a/lib/cosTime/doc/src/ref_man.xml b/lib/cosTime/doc/src/ref_man.xml deleted file mode 100644 index 66bca4af0e..0000000000 --- a/lib/cosTime/doc/src/ref_man.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - -
- - 20002016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - cosTime Reference Manual - Niclas Eklund - - 2000-01-31 - 1.0 -
- -

The cosTime application is an Erlang implementation of the OMG - CORBA Time and TimerEvent Services.

-
- - - - - - -
- -- cgit v1.2.3