User's Guide
Reference Manual
Release Notes
PDF
Top

cosTime
Reference Manual
Version 1.1.13

Expand All
Contract All

Table of Contents

# 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.