User's Guide
Reference Manual
Release Notes
PDF
Top

cosTime
Reference Manual
Version 1.2

Expand All
Contract All

Table of Contents

- cosTime
  - Top of manual page
  - install_time/0
  - uninstall_time/0
  - install_timerevent/0
  - uninstall_timerevent/0
  - start/0
  - stop/0
  - start_time_service/2
  - stop_time_service/1
  - start_timerevent_service/1
  - stop_timerevent_service/1
- CosTime_TIO
  - Top of manual page
  - '_get_time_interval'/1
  - spans/2
  - overlaps/2
  - time/1
- CosTime_TimeService
  - Top of manual page
  - universal_time/1
  - new_universal_time/4
  - uto_from_utc/2
  - new_interval/3
- CosTime_UTO
  - Top of manual page
  - '_get_time'/1
  - '_get_inaccuracy'/1
  - '_get_tdf'/1
  - '_get_utc_time'/1
  - absolute_time/1
  - compare_time/3
  - time_to_interval/2
  - interval/1
- CosTimerEvent_TimerEventHandler
  - Top of manual page
  - '_get_status'/1
  - time_set/1
  - set_timer/3
  - cancel_timer/1
  - set_data/2
- CosTimerEvent_TimerEventService
  - Top of manual page
  - register/3
  - unregister/2
  - event_time/2

# CosTimerEvent_TimerEventService

### MODULE

CosTimerEvent_TimerEventService

### MODULE SUMMARY

This module implements the OMG CosTimerEvent::TimerEventService interface.

### DESCRIPTION

To get access to the record definitions for the structures use:
-include_lib("cosTime/include/*.hrl").

### EXPORTS

register(TimerEventService, CosEventCommPushConsumer, Data) -> TimerEventHandler

Types:

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

Types:

TimerEventService = TimerEventHandler = #objref

This operation will terminate the given TimerEventHandler.

event_time(TimerEventService, TimerEvent) -> UTO

Types:

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.