table of contents
other versions
- jessie 1:17.3-dfsg-4+deb8u2
- jessie-backports 1:19.2.1+dfsg-2+deb9u1~bpo8+1
- stretch 1:19.2.1+dfsg-2+deb9u2
cosTime(3erl) | Erlang Module Definition | cosTime(3erl) |
NAME¶
cosTime - The main module of the cosTime applicationDESCRIPTION¶
To get access to the record definitions for the structures use:EXPORTS¶
install_time() -> Return
Types:
Return = ok | {'EXIT', Reason}
This operation installs the cosTime Time Service part application.
uninstall_time() -> Return
Types:
Return = ok | {'EXIT', Reason}
This operation uninstalls the cosTime Time Service part application.
install_timerevent() -> Return
Types:
Return = ok | {'EXIT', Reason}
This operation installs the cosTime Timer Event Service part application.
uninstall_timerevent() -> Return
Note:
The Timer Event Service part requires Time Service part and
cosEvent or the cosNotification application to be installed
first.
Types:
Return = ok | {'EXIT', Reason}
This operation uninstalls the cosTime Timer Event Service part
application.
start() -> Return
Types:
Return = ok | {error, Reason}
This operation starts the cosTime application.
stop() -> Return
Types:
Return = ok | {error, Reason}
This operation stops the cosTime application.
start_time_service(Tdf, Inaccuracy) -> Return
Types:
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
Types:
TimeService = #objref
This operation stops the Time Service object.
start_timerevent_service(TimeService) -> ok
Types:
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
Types:
TimerEventService = #objref
This operation stops the Timer Event Service object.
cosTime 1.2.2 | Ericsson AB |