COSNOTIFYFILTER_MAPPINGFILTER(3erl)

✨ CosNotifyFilter_MappingFilter ✨

okay bestie, so this is CosNotifyFilter_MappingFilter from the cosNotification manual (section 3erl), and it's literally the Erlang module that implements the OMG CosNotifyFilter::MappingFilter interface. yes we're doing CORBA today, get comfy 💅

---

🎀 NAME 🎀

CosNotifyFilter_MappingFilter — this module implements the OMG CosNotifyFilter::MappingFilter interface. no cap, that's the whole job description.

---

🦋 DESCRIPTION 🦋

okay so the main character purpose of this module? it matches events against the constraints you've associated with it, and then it returns the value for the first constraint that returns true for the given event. if literally every constraint returns false, then the default value gets returned instead. periodt. 💖

and to get access to the record definitions for the structures, you do:

-include_lib("cosNotification/include/*.hrl").

iykyk 🌸

---

👑 EXPORTS 👑

💜 _get_constraint_grammar(MappingFilter) -> Grammar

Types:

MappingFilter = #objref
Grammar = string()

this operation returns which type of Grammar the MappingFilter uses. and currently? only "EXTENDED_TCL" is supported. that's the one, that's the vibe ✨

💜 _get_value_type(MappingFilter) -> CORBA::TypeCode

Types:

MappingFilter = #objref

this readonly attribute maintains the CORBA::TypeCode of the default value associated with the target object. read it and weep, but like, respectfully 🫶

💜 _get_default_value(MappingFilter) -> #any

Types:

MappingFilter = #objref

this readonly attribute maintains the #any{} default value associated with the target object. it's giving "the fallback, but make it CORBA" 🎀

💜 add_mapping_constraints(MappingFilter, MappingConstraintPairSeq) -> Reply

Types:

MappingFilter = #objref
MappingConstraintPairSeq = [MappingConstraintPair]
MappingConstraintPair = #'CosNotifyFilter_MappingConstraintPair'{constraint_expression, result_to_set}
constraint_expression = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}
event_types = #'CosNotification_EventTypeSeq'{}
constraint_expr = string()
result_to_set = #any
Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_InvalidConstraint'{constr}} | {'EXCEPTION', #'CosNotifyFilter_InvalidValue'{constr, value}}
constr = ConstraintExp
ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}
event_types = #'CosNotification_EventTypeSeq'{}
constraint_expr = string()
MappingConstraintInfoSeq = [MappingConstraintInfo]
MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}
constraint_expression = ConstraintExp
constraint_id = long()
value = #any

this operation adds new mapping constraints, which will be used when trying to override Quality of Service settings defined in the given event. so if a constraint returns true, the associated value gets returned — otherwise you get the default value. simple as that 🌈

💜 modify_constraints(MappingFilter, ConstraintIDSeq, MappingConstraintInfoSeq) -> Reply

Types:

MappingFilter = #objref
ConstraintIDSeq = [ConstraintID]
ConstraintID = long()
MappingConstraintInfoSeq = [MappingConstraintInfo]
MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}
constraint_expression = ConstraintExp
constraint_id = long()
value = #any
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}} | {'EXCEPTION', #'CosNotifyFilter_InvalidValue'{constr, value}}
constr = ConstraintExp
id = long()
value = #any
ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}
event_types = #'CosNotification_EventTypeSeq'{}
constraint_expr = string()

so the ConstraintIDSeq you supply should relate to the constraints the caller wants to remove. and if any of the supplied Id's aren't found? an exception gets raised. 😭 this operation also accepts a sequence of MappingConstraintInfo which will be added. and if the target object can't modify the constraints as requested, an exception is raised describing which constraint — and why — could not be updated. receipts included 💀

💜 get_mapping_constraints(MappingFilter, ConstraintIDSeq) -> Reply

Types:

MappingFilter = #objref
ConstraintIDSeq = [ConstraintID]
ConstraintID = long()
Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotifyFilter_ConstraintNotFound'{id}}
MappingConstraintInfoSeq = [MappingConstraintInfo]
MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}
constraint_expression = ConstraintExp
ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}
event_types = #'CosNotification_EventTypeSeq'{}
constraint_expr = string()
constraint_id = id = long()
value = #any

when you add a new constraint, a unique Id is returned, and that Id is accepted as input for this operation. the associated constraint gets returned — but if no such Id exists, an exception is raised. so keep track of your Ids bestie, they're your children now 🙈

💜 get_all_mapping_constraints(MappingFilter) -> MappingConstraintInfoSeq

Types:

MappingFilter = #objref
MappingConstraintInfoSeq = [MappingConstraintInfo]
MappingConstraintInfo = #'CosNotifyFilter_MappingConstraintInfo'{constraint_expression, constraint_id, value}
constraint_expression = ConstraintExp
ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types, constraint_expr}
event_types = #'CosNotification_EventTypeSeq'{}
constraint_expr = string()
constraint_id = long()
value = #any

this operation returns a sequence of all the unique Id's associated with the target object. and if no constraint has been added at all, the sequence will just be empty. empty. void. a little sad, honestly 🍓

💜 remove_all_mapping_constraints(MappingFilter) -> ok

Types:

MappingFilter = #objref

this operation removes all constraints associated with the target object. all of them. gone. clean slate energy ✨

💜 destroy(MappingFilter) -> ok

Types:

MappingFilter = #objref

this operation terminates the target object. 💀 and remember to remove this Filter from the objects it has been associated with — do not skip this step, it's important fr fr.

💜 match(MappingFilter, Event) -> Reply

Types:

MappingFilter = #objref
Event = #any
Reply = {boolean(), #any} | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}

this operation evaluates Any events with the Filter's constraints, and returns the value to use. that value is the default value if all constraints return false, and the value associated with the first constraint returning true. first one wins, no negotiating 🔥

💜 match_structured(MappingFilter, Event) -> Reply

Types:

MappingFilter = #objref
Event = #'CosNotification_StructuredEvent'{}
Reply = {boolean(), #any} | {'EXCEPTION', #'CosNotifyFilter_UnsupportedFilterableData'{}}

similar to match/2 but it accepts a structured event as input. same energy, fancier event 🦋

---

and that's the whole page bestie, you ate it, you understood it, main character energy only 👑

Ericsson AB · cosNotification 5.2.2 · CosNotifyFilter_MappingFilter(3) — mwah, go forth and filter 💖🎀🫶