Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

costimerevent_timereventhandler(3erl) [linux man page]

CosTimerEvent_TimerEventHandler(3erl)			     Erlang Module Definition			     CosTimerEvent_TimerEventHandler(3erl)

NAME

       CosTimerEvent_TimerEventHandler - This module implements the OMG  CosTimerEvent::TimerEventHandler interface.

DESCRIPTION

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

EXPORTS

       '_get_status'(TimerEventHandler) -> Reply

	      Types  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

	      Types  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()

	      Types  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()

	      Types  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

	      Types  TimerEventHandler = #objref
		     EventData = #any

	      This operation changes the event data sent when triggered.

Ericsson AB							  cosTime 1.1.10			     CosTimerEvent_TimerEventHandler(3erl)

Check Out this Related Man Page

CosNotifyFilter_FilterAdmin(3erl)			     Erlang Module Definition				 CosNotifyFilter_FilterAdmin(3erl)

NAME

       CosNotifyFilter_FilterAdmin - This module implements the OMG CosNotifyFilter::FilterAdmin interface.

DESCRIPTION

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

       All objects, which inherit this interface, export functions described in this module.

EXPORTS

       add_filter(Object, Filter) -> FilterID

	      Types  Object = #objref
		     Filter = #objref
		     FilterID = long()

	      This  operation  connects  a  new Filter to the target object. This Filter will, together with other associated Filters , be used to
	      select events to forward. A unique Id is returned and should be used if we no longer want to consult the given Filter .

       remove_filter(Object, FilterID) -> ok

	      Types  Object = #objref
		     FilterID = long()

	      If a certain Filter no longer should be associated with the target object this operation must be used.  Events  will  no	longer	be
	      tested against the Filter associated with the given Id.

       get_filter(Object, FilterID) -> Reply

	      Types  Object = #objref
		     FilterID = long()
		     Reply = Filter | {'EXCEPTION', #'CosNotifyFilter_FilterNotFound'{}}
		     Filter = #objref

	      If the target object is associated with a Filter matching the given Id the reference will be returned. If no such Filter is known by
	      the target object an exception is raised.

       get_all_filters(Object) -> FilterIDSeq

	      Types  Object = #objref
		     FilterIDSeq = [FilterID]
		     FilterID = long()

	      Id's for all Filter objects associated with the target object is returned by this operation.

       remove_all_filters(Object) -> ok

	      Types  Object = #objref

	      If we want to remove all Filters associated with the target object we can use this function.

Ericsson AB						      cosNotification 1.1.16				 CosNotifyFilter_FilterAdmin(3erl)
Man Page