Unix/Linux Go Back    


Linux 2.6 - man page for cosnotifyfilter_filter (linux section 3erl)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


CosNotifyFilter_Filter(3erl)	     Erlang Module Definition	     CosNotifyFilter_Filter(3erl)

NAME
       CosNotifyFilter_Filter - This module implements the OMG CosNotifyFilter::Filter interface.

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

EXPORTS
       _get_constraint_grammar(Filter) -> Grammar

	      Types  Filter = #objref
		     Grammar = string()

	      This  operation  returns	which  type  of  Grammar the Filter uses. Currently, only
	      "EXTENDED_TCL" is supported.

       add_constraints(Filter, ConstraintExpSeq) -> Reply

	      Types  Filter = #objref
		     ConstraintExpSeq = [Constraint]
		     ConstraintExp    =    #'CosNotifyFilter_ConstraintExp'{event_types,     con-
		     straint_expr}
		     event_types = #'CosNotification_EventTypeSeq'{}
		     constraint_expr = string()
		     Reply  =  ConstraintInfoSeq  |  {'EXCEPTION',  #'CosNotifyFilter_InvalidCon-
		     straint'{constr}}
		     constr = ConstraintExp
		     ConstraintInfoSeq = [ConstraintInfo]
		     ConstraintInfo  =	 #'CosNotifyFilter_ConstraintInfo'{constraint_expression,
		     constraint_id}
		     constraint_expression = ConstraintExp
		     constraint_id = long()

	      Initially,  Filters  do not contain any constraints, hence, all events will be for-
	      warded. The add_constraints/2 operation allow us to add constraints to  the  target
	      object.

       modify_constraints(Filter, ConstraintIDSeq, ConstraintInfoSeq) -> Reply

	      Types  Filter = #objref
		     ConstraintIDSeq = [ConstraintID]
		     ConstraintID = long()
		     ConstraintInfoSeq = [ConstraintInfo]
		     ConstraintInfo   =  #'CosNotifyFilter_ConstraintInfo'{constraint_expression,
		     constraint_id}
		     constraint_expression = ConstraintExp
		     constraint_id = long()
		     Reply = ok | {'EXCEPTION',  #'CosNotifyFilter_InvalidConstraint'{constr}}	|
		     {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}}
		     constr = ConstraintExp
		     id = long()
		     ConstraintExp     =    #'CosNotifyFilter_ConstraintExp'{event_types,    con-
		     straint_expr}
		     event_types = #'CosNotification_EventTypeSeq'{}
		     constraint_expr = string()

	      This operation is invoked by a client in order to modify the constraints associated
	      with  the  target  object.  The  constraints  related  to the Id's in the parameter
	      sequence ConstraintIDSeq will, if all  values  are  valid,  be  deleted.	The  Con-
	      straintInfoSeq  parameter contains of Id-Expression pairs and a constraint matching
	      one of the unique Id's will, if all input values are correct, be	updated.  If  the
	      parameters contain incorrect data en exception will be raised.

       get_constraints(Filter, ConstraintIDSeq) -> Reply

	      Types  Filter = #objref
		     ConstraintIDSeq = [ConstraintID]
		     ConstraintID = long()
		     Reply  =  ConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_ConstraintNot-
		     Found'{id}}
		     ConstraintInfoSeq = [ConstraintInfo]
		     ConstraintInfo  =	 #'CosNotifyFilter_ConstraintInfo'{constraint_expression,
		     constraint_id}
		     constraint_expression = ConstraintExp
		     constraint_id = id = long()

	      This  operation  return  a  sequence of ConstraintInfo's, related to the given Con-
	      straintID's, associated with the target object.

       get_all_constraints(Filter) -> ConstraintInfoSeq

	      Types  Filter = #objref
		     ConstraintInfoSeq = [ConstraintInfo]
		     ConstraintInfo  =	 #'CosNotifyFilter_ConstraintInfo'{constraint_expression,
		     constraint_id}
		     constraint_expression = ConstraintExp
		     constraint_id = long()

	      All  constraints,  and  their  unique Id, associated with the target object will be
	      returned by this operation.

       remove_all_constraints(Filter) -> ok

	      Types  Filter = #objref

	      All constraints associated with the target object are  removed  by  this	operation
	      and,  since  the	the  target  object  no longer contain any constraints, true will
	      always be the result of any match operation.

       destroy(Filter) -> ok

	      Types  Filter = #objref

	      This operation terminates the target object.

       match(Filter, Event) -> Reply

	      Types  Filter = #objref
		     Event = #any
		     Reply = boolean() |  {'EXCEPTION',  #'CosNotifyFilter_UnsupportedFilterable-
		     Data'{}}

	      This  operation  accepts	an #any{} event and returns true if it satisfies at least
	      one constraint. If the event contains data of the wrong type,  e.g.,  should  be	a
	      string() but in fact i a short(), an exception is raised.

       match_structured(Filter, Event) -> Reply

	      Types  Filter = #objref
		     Event = #'CosNotification_StructuredEvent'{}
		     Reply  =  boolean() | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterable-
		     Data'{}}

	      This operation is similar to the match  operation  but  accepts  structured  events
	      instead.

       attach_callback(Filter, NotifySubscribe) -> CallbackID

	      Types  Filter = #objref
		     NotifySubscribe = #objref
		     CallbackID = long()

	      This operation connects a NotifySubscribe object, which should be informed when the
	      target object's constraints are updated. A unique Id  is	returned  which  must  be
	      stored if we ever want to detach the callback object in the future.

       detach_callback(Filter, CallbackID) -> Reply

	      Types  Filter = #objref
		     CallbackID = long()
		     Reply = ok | {'EXCEPTION', #'CosNotifyFilter_CallbackNotFound'{}}

	      If  the  target  object  has an associated callback that matches the supplied Id it
	      will be removed and longer informed of any updates. If no object with a matching Id
	      is found an exception is raised.

       get_callbacks(Filter) -> CallbackIDSeq

	      Types  Filter = #objref
		     CallbackIDSeq = [CallbackID]
		     CallbackID = long()

	      This  operation returns a sequence of all connected NotifySubscribe object Id's. If
	      no callbacks are associated with the target object the list will be empty.

Ericsson AB			      cosNotification 1.1.16	     CosNotifyFilter_Filter(3erl)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 04:48 PM.