2000 2013 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.