1orber_ifr(3) Erlang Module Definition orber_ifr(3)
2
6 orber_ifr - The Interface Repository stores representations of IDL in‐
7 formation
8
10 This module contains functions for managing the Interface Repository
11 (IFR). This documentation should be used in conjunction with the docu‐
12 mentation in chapter 6 of 2.3. Whenever the term IFR object is used in
13 this manual page, it refers to a pseudo object used only for interac‐
14 tion with the IFR rather than a CORBA object.
15
17 The following functions are used to initialize the Interface Repository
18 and to obtain the initial reference to the repository.
19
21 init(Nodes,Timeout) -> ok
22 Types:
24 Nodes = list()
26 Timeout = integer() | infinity
27 This function should be called to initialize the IFR. It creates
29 the necessary mnesia-tables. A mnesia schema should exist, and
30 mnesia must be running.
31 find_repository() -> #IFR_Repository_objref
33 Find the IFR object reference for the Repository. This reference
35 should be used when adding objects to the IFR, and when extract‐
36 ing information from the IFR. The first time this function is
37 called, it will create the repository and all the primitive def‐
38 initions.
39
41 The following functions are the methods of the IFR. The first argument
42 is always an #IFR_objref, i.e. the IFR (pseudo)object on which to apply
43 this method. These functions are useful when the type of IFR object is
44 not know, but they are somewhat slower than the specific functions
45 listed below which only accept a particular type of IFR object as the
46 first argument.
47
49 get_def_kind(Objref) -> Return
50 Types:
52 Objref = #IFR_objref
54 Return = atom() (one of dk_none, dk_all, dk_Attribute,
55 dk_Constant, dk_Exception, dk_Interface, dk_Module, dk_Opera‐
56 tion, dk_Typedef, dk_Alias, dk_Struct, dk_Union, dk_Enum,
57 dk_Primitive, dk_String, dk_Wstring, dk_Fixed, dk_Sequence,
58 dk_Array, dk_Repository)
59 Objref is an IFR object of any kind. Returns the definition kind
61 of the IFR object.
62 destroy(Objref) -> Return
64 Types:
66 Objref = #IFR_object
68 Return = tuple()
69 Objref is an IFR object of any kind except IRObject, Contained
71 and Container. Destroys that object and its contents (if any).
72 Returns whatever mnesia:transaction returns.
73 get_id(Objref) -> Return
75 Types:
77 Objref = #IFR_object
79 Return = string()
80 Objref is an IFR object of any kind that inherits from Con‐
82 tained. Returns the repository id of that object.
83 set_id(Objref,Id) -> ok
85 Types:
87 Objref = #IFR_object
89 Id = string()
90 Objref is an IFR object of any kind that inherits from Con‐
92 tained. Sets the repository id of that object.
93 get_name(Objref) -> Return
95 Types:
97 Objref = #IFR_object
99 Return = string()
100 Objref is an IFR object of any kind that inherits from Con‐
102 tained. Returns the name of that object.
103 set_name(Objref,Name) -> ok
105 Types:
107 Objref = #IFR_object
109 Name = string()
110 Objref is an IFR object of any kind that inherits from Con‐
112 tained. Sets the name of that object.
113 get_version(Objref) -> Return
115 Types:
117 Objref = #IFR_object
119 Return = string()
120 Objref is an IFR object of any kind that inherits from Con‐
122 tained. Returns the version of that object.
123 set_version(Objref,Version) -> ok
125 Types:
127 Objref = #IFR_object
129 Version = string()
130 Objref is an IFR object of any kind that inherits from Con‐
132 tained. Sets the version of that object.
133 get_defined_in(Objref) -> Return
135 Types:
137 Objref = #IFR_object
139 Return = #IFR_Container_objref
140 Objref is an IFR object of any kind that inherits from Con‐
142 tained. Returns the Container object that the object is defined
143 in.
144 get_absolute_name(Objref) -> Return
146 Types:
148 Objref = #IFR_object
150 Return = string()
151 Objref is an IFR object of any kind that inherits from Con‐
153 tained. Returns the absolute (scoped) name of that object.
154 get_containing_repository(Objref) -> Return
156 Types:
158 Objref = #IFR_object
160 Return = #IFR_Repository_objref
161 Objref is an IFR object of any kind that inherits from Con‐
163 tained. Returns the Repository that is eventually reached by re‐
164 cursively following the object's defined_in attribute.
165 describe(Objref) -> Return
167 Types:
169 Objref = #IFR_object
171 Return = tuple() (a contained_description record) | {excep‐
172 tion, _}
173 Objref is an IFR object of any kind that inherits from Con‐
175 tained. Returns a tuple describing the object.
176 move(Objref,New_container,New_name,New_version) -> Return
178 Types:
180 Objref = #IFR_objref
182 New_container = #IFR_Container_objref
183 New_name = string()
184 New_version = string()
185 Return = ok | {exception, _}
186 Objref is an IFR object of any kind that inherits from Con‐
188 tained. New_container is an IFR object of any kind that inherits
189 from Container. Removes Objref from its current Container, and
190 adds it to New_container. The name attribute is changed to
191 New_name and the version attribute is changed to New_version.
192 lookup(Objref,Search_name) -> Return
194 Types:
196 Objref = #IFR_objref
198 Search_name = string()
199 Return = #IFR_object
200 Objref is an IFR object of any kind that inherits from Con‐
202 tainer. Returns an IFR object identified by search_name (a
203 scoped name).
204 contents(Objref,Limit_type,Exclude_inherited) -> Return
206 Types:
208 Objref = #IFR_objref
210 Limit_type = atom() (one of dk_none, dk_all, dk_Attribute,
211 dk_Constant, dk_Exception, dk_Interface, dk_Module, dk_Opera‐
212 tion, dk_Typedef, dk_Alias, dk_Struct, dk_Union, dk_Enum,
213 dk_Primitive, dk_String, dk_Wstring, dk_Fixed, dk_Sequence,
214 dk_Array, dk_Repository)
215 Exclude_inherited = atom() (true or false)
216 Return = list() (a list of IFR#_objects)
217 Objref is an IFR object of any kind that inherits from Con‐
219 tainer. Returns the contents of that IFR object.
220 lookup_name(Objref,Search_name,Levels_to_search, Limit_type, Ex‐
222 clude_inherited) -> Return
223 Types:
225 Objref = #IFR_objref
227 Search_name = string()
228 Levels_to_search = integer()
229 Limit_type = atom() (one of dk_none, dk_all, dk_Attribute,
230 dk_Constant, dk_Exception, dk_Interface, dk_Module, dk_Opera‐
231 tion, dk_Typedef, dk_Alias, dk_Struct, dk_Union, dk_Enum,
232 dk_Primitive, dk_String, dk_Wstring, dk_Fixed, dk_Sequence,
233 dk_Array, dk_Repository)
234 Exclude_inherited = atom() (true or false)
235 Return = list() (a list of #IFR_objects)
236 Objref is an IFR object of any kind that inherits from Con‐
238 tainer. Returns a list of #IFR_objects with an id matching
239 Search_name.
240 describe_contents(Objref, Limit_type, Exclude_inherited, Max_re‐
242 turned_objs) -> Return
243 Types:
245 Objref = #IFR_objref
247 Limit_type = atom() (one of dk_none, dk_all, dk_Attribute,
248 dk_Constant, dk_Exception, dk_Interface, dk_Module, dk_Opera‐
249 tion, dk_Typedef, dk_Alias, dk_Struct, dk_Union, dk_Enum,
250 dk_Primitive, dk_String, dk_Wstring, dk_Fixed, dk_Sequence,
251 dk_Array, dk_Repository)
252 Exclude_inherited = atom() (true or false)
253 Return = list() (a list of tuples (contained_description
254 records) | {exception, _}
255 Objref is an IFR object of any kind that inherits from Con‐
257 tainer. Returns a list of descriptions of the IFR objects in
258 this Container's contents.
259 create_module(Objref,Id,Name,Version) -> Return
261 Types:
263 Objref = #IFR_objref
265 Id = string()
266 Name = string()
267 Version = string()
268 Return = #IFR_ModuleDef_objref
269 Objref is an IFR object of any kind that inherits from Con‐
271 tainer. Creates an IFR object of the type ModuleDef.
272 create_constant(Objref,Id,Name,Version,Type,Value) -> Return
274 Types:
276 Objref = #IFR_objref
278 Id = string()
279 Name = string()
280 Version = string()
281 Type = #IFR_IDLType_objref
282 Value = any()
283 Return = #IFR_ConstantDef_objref
284 Objref is an IFR object of any kind that inherits from Con‐
286 tainer. Creates an IFR object of the type ConstantDef.
287 create_struct(Objref,Id,Name,Version,Members) -> Return
289 Types:
291 Objref = #IFR_objref
293 Id = string()
294 Name = string()
295 Version = string()
296 Members = list() (list of structmember records)
297 Return = #IFR_StructDef_objref
298 Objref is an IFR object of any kind that inherits from Con‐
300 tainer. Creates an IFR object of the type StructDef.
301 create_union(Objref,Id,Name,Version,Discriminator_type,Members) -> Re‐
303 turn
304 Types:
306 Objref = #IFR_objref
308 Id = string()
309 Name = string()
310 Version = string()
311 Discriminator_type = #IFR_IDLType_Objref
312 Members = list() (list of unionmember records)
313 Return = #IFR_UnionDef_objref
314 Objref is an IFR object of any kind that inherits from Con‐
316 tainer. Creates an IFR object of the type UnionDef.
317 create_enum(Objref,Id,Name,Version,Members) -> Return
319 Types:
321 Objref = #IFR_objref
323 Id = string()
324 Name = string()
325 Version = string()
326 Members = list() (list of strings)
327 Return = #IFR_EnumDef_objref
328 Objref is an IFR object of any kind that inherits from Con‐
330 tainer. Creates an IFR object of the type EnumDef.
331 create_alias(Objref,Id,Name,Version,Original_type) -> Return
333 Types:
335 Objref = #IFR_objref
337 Id = string()
338 Name = string()
339 Version = string()
340 Original_type = #IFR_IDLType_Objref
341 Return = #IFR_AliasDef_objref
342 Objref is an IFR object of any kind that inherits from Con‐
344 tainer. Creates an IFR object of the type AliasDef.
345 create_interface(Objref,Id,Name,Version,Base_interfaces) -> Return
347 Types:
349 Objref = #IFR_objref
351 Id = string()
352 Name = string()
353 Version = string()
354 Base_interfaces = list() (a list of IFR_InterfaceDef_objrefs
355 that this interface inherits from
356 Return = #IFR_InterfaceDef_objref
357 Objref is an IFR object of any kind that inherits from Con‐
359 tainer. Creates an IFR object of the type InterfaceDef.
360 create_exception(Objref,Id,Name,Version,Members) -> Return
362 Types:
364 Objref = #IFR_objref
366 Id = string()
367 Name = string()
368 Version = string()
369 Members = list() (list of structmember records)
370 Return = #IFR_ExceptionDef_objref
371 Objref is an IFR object of any kind that inherits from Con‐
373 tainer. Creates an IFR object of the type ExceptionDef.
374 get_type(Objref) -> Return
376 Types:
378 Objref = #IFR_objref
380 Return = tuple() (a typecode tuple)
381 Objref is an IFR object of any kind that inherits from IDLType
383 or an IFR object of the kind ConstantDef, ExceptionDef or At‐
384 tributeDef. Returns the typecode of the IFR object.
385 lookup_id(Objref,Search_id) -> Return
387 Types:
389 Objref = #IFR_Repository_objref
391 Search_id = string()
392 Return = #IFR_objref
393 Returns an IFR object matching the Search_id.
395 get_primitive(Objref,Kind) -> Return
397 Types:
399 Objref = #IFR_Repository_objref
401 Kind = atom() (one of pk_null, pk_void, pk_short, pk_long,
402 pk_ushort, pk_ulong, pk_float, pk_double, pk_boolean,
403 pk_char, pk_octet, pk_any, pk_TypeCode, pk_Principal,
404 pk_string, pk_wstring, pk_fixed, pk_objref)
405 Return = #IFR_PrimitiveDef_objref
406 Returns a PrimitiveDef of the specified kind.
408 create_string(Objref,Bound) -> Return
410 Types:
412 Objref = #IFR_Repository_objref
414 Bound = integer() (unsigned long /= 0)
415 Return = #IFR_StringDef_objref
416 Creates an IFR objref of the type StringDef.
418 create_wstring(Objref,Bound) -> Return
420 Types:
422 Objref = #IFR_Repository_objref
424 Bound = integer() (unsigned long /= 0)
425 Return = #IFR_WstringDef_objref
426 Creates an IFR objref of the type WstringDef.
428 create_fixed(Objref,Digits,Scale) -> Return
430 Types:
432 Objref = #IFR_Repository_objref
434 Digits = Scale = integer()
435 Return = #IFR_FixedDef_objref
436 Creates an IFR objref of the type FixedDef.
438 create_sequence(Objref,Bound,Element_type) -> Return
440 Types:
442 Objref = #IFR_Repository_objref
444 Bound = integer() (unsigned long)
445 Element_type = #IFR_IDLType_objref
446 Return = #IFR_SequenceDef_objref
447 Creates an IFR objref of the type SequenceDef.
449 create_array(Objref,Length,Element_type) -> Return
451 Types:
453 Objref = #IFR_Repository_objref
455 Bound = integer() (unsigned long)
456 Element_type = #IFR_IDLType_objref
457 Return = #IFR_ArrayDef_objref
458 Creates an IFR objref of the type ArrayDef.
460 create_idltype(Objref,Typecode) -> Return
462 Types:
464 Objref = #IFR_Repository_objref
466 Typecode = tuple() (a typecode tuple)
467 Return = #IFR_IDLType_objref
468 Creates an IFR objref of the type IDLType.
470 get_type_def(Objref) -> Return
472 Types:
474 Objref = #IFR_objref
476 Return = #IFR_IDLType_objref
477 Objref is an IFR object of the kind ConstantDef or AttributeDef.
479 Returns an IFR object of the type IDLType describing the type of
480 the IFR object.
481 set_type_def(Objref,TypeDef) -> Return
483 Types:
485 Objref = #IFR_objref
487 TypeDef = #IFR_IDLType_objref
488 Return = ok | {exception, _}
489 Objref is an IFR object of the kind ConstantDef or AttributeDef.
491 Sets the type_def of the IFR Object.
492 get_value(Objref) -> Return
494 Types:
496 Objref = #IFR_ConstantDef_objref
498 Return = any()
499 Returns the value attribute of an IFR Object of the type Con‐
501 stantDef.
502 set_value(Objref,Value) -> Return
504 Types:
506 Objref = #IFR_ConstantDef_objref
508 Value = any()
509 Return = ok | {exception, _}
510 Sets the value attribute of an IFR Object of the type Constant‐
512 Def.
513 get_members(Objref) -> Return
515 Types:
517 Objref = #IFR_objref
519 Return = list()
520 Objref is an IFR object the kind StructDef, UnionDef, EnumDef or
522 ExceptionDef. For StructDef, UnionDef and ExceptionDef: Returns
523 a list of structmember records that are the constituent parts of
524 the object. For EnumDef: Returns a list of strings describing
525 the enumerations.
526 set_members(Objref,Members) -> Return
528 Types:
530 Objref = #IFR_objref
532 Members = list()
533 Return = ok | {exception, _}
534 Objref is an IFR object the kind StructDef, UnionDef, EnumDef or
536 ExceptionDef. For StructDef, UnionDef and ExceptionDef: Members
537 is a list of structmember records. For EnumDef: Members is a
538 list of strings describing the enumerations. Sets the members
539 attribute, which are the constituent parts of the exception.
540 get_discriminator_type(Objref) -> Return
542 Types:
544 Objref = #IFR_UnionDef_objref
546 Return = tuple() (a typecode tuple)
547 Returns the discriminator typecode of an IFR object of the type
549 UnionDef.
550 get_discriminator_type_def(Objref) -> Return
552 Types:
554 Objref = #IFR_UnionDef_objref
556 Return = #IFR_IDLType_objref
557 Returns an IFR object of the type IDLType describing the dis‐
559 criminator type of an IFR object of the type UnionDef.
560 set_discriminator_type_def(Objref,TypeDef) -> Return
562 Types:
564 Objref = #IFR_UnionDef_objref
566 Return = #IFR_IDLType_objref
567 Sets the attribute discriminator_type_def, an IFR object of the
569 type IDLType describing the discriminator type of an IFR object
570 of the type UnionDef.
571 get_original_type_def(Objref) -> Return
573 Types:
575 Objref = #IFR_AliasDef_objref
577 Return = #IFR_IDLType_objref
578 Returns an IFR object of the type IDLType describing the origi‐
580 nal type.
581 set_original_type_def(Objref,TypeDef) -> Return
583 Types:
585 Objref = #IFR_AliasDef_objref
587 Typedef = #IFR_IDLType_objref
588 Return = ok | {exception, _}
589 Sets the original_type_def attribute which describes the origi‐
591 nal type.
592 get_kind(Objref) -> Return
594 Types:
596 Objref = #IFR_PrimitiveDef_objref
598 Return = atom()
599 Returns an atom describing the primitive type (See CORBA 2.0 p
601 6-21).
602 get_bound(Objref) -> Return
604 Types:
606 Objref = #IFR_objref
608 Return = integer (unsigned long)
609 Objref is an IFR object the kind StringDef or SequenceDef. For
611 StringDef: returns the maximum number of characters in the
612 string. For SequenceDef: Returns the maximum number of elements
613 in the sequence. Zero indicates an unbounded sequence.
614 set_bound(Objref,Bound) -> Return
616 Types:
618 Objref = #IFR_objref
620 Bound = integer (unsigned long)
621 Return = ok | {exception, _}
622 Objref is an IFR object the kind StringDef or SequenceDef. For
624 StringDef: Sets the maximum number of characters in the string.
625 Bound must not be zero. For SequenceDef: Sets the maximum number
626 of elements in the sequence. Zero indicates an unbounded se‐
627 quence.
628 get_element_type(Objref) -> Return
630 Types:
632 Objref = #IFR_objref
634 Return = tuple() (a typecode tuple)
635 Objref is an IFR object the kind SequenceDef or ArrayDef. Re‐
637 turns the typecode of the elements in the IFR object.
638 get_element_type_def(Objref) -> Return
640 Types:
642 Objref = #IFR_objref
644 Return = #IFR_IDLType_objref
645 Objref is an IFR object the kind SequenceDef or ArrayDef. Re‐
647 turns an IFR object of the type IDLType describing the type of
648 the elements in Objref.
649 set_element_type_def(Objref,TypeDef) -> Return
651 Types:
653 Objref = #IFR_objref
655 TypeDef = #IFR_IDLType_objref
656 Return = ok | {exception, _}
657 Objref is an IFR object the kind SequenceDef or ArrayDef. Sets
659 the element_type_def attribute, an IFR object of the type IDL‐
660 Type describing the type of the elements in Objref.
661 get_length(Objref) -> Return
663 Types:
665 Objref = #IFR_ArrayDef_objref
667 Return = integer() (unsigned long)
668 Returns the number of elements in the array.
670 set_length(Objref,Length) -> Return
672 Types:
674 Objref = #IFR_ArrayDef_objref
676 Length = integer() (unsigned long)
677 Sets the number of elements in the array.
679 get_mode(Objref) -> Return
681 Types:
683 Objref = #IFR_objref
685 Return = atom()
686 Objref is an IFR object the kind AttributeDef or OperationDef.
688 For AttributeDef: Return is an atom ('ATTR_NORMAL' or
689 'ATTR_READONLY') specifying the read/write access for this at‐
690 tribute. For OperationDef: Return is an atom ('OP_NORMAL' or
691 'OP_ONEWAY') specifying the mode of the operation.
692 set_mode(Objref,Mode) -> Return
694 Types:
696 Objref = #IFR_objref
698 Mode = atom()
699 Return = ok | {exception, _}
700 Objref is an IFR object the kind AttributeDef or OperationDef.
702 For AttributeDef: Sets the read/write access for this attribute.
703 Mode is an atom ('ATTR_NORMAL' or 'ATTR_READONLY'). For Opera‐
704 tionDef: Sets the mode of the operation. Mode is an atom
705 ('OP_NORMAL' or 'OP_ONEWAY').
706 get_result(Objref) -> Return
708 Types:
710 Objref = #IFR_OperationDef_objref
712 Return = tuple() (a typecode tuple)
713 Returns a typecode describing the type of the value returned by
715 the operation.
716 get_result_def(Objref) -> Return
718 Types:
720 Objref = #IFR_OperationDef_objref
722 Return = #IFR_IDLType_objref
723 Returns an IFR object of the type IDLType describing the type of
725 the result.
726 set_result_def(Objref,ResultDef) -> Return
728 Types:
730 Objref = #IFR_OperationDef_objref
732 ResultDef = #IFR_IDLType_objref
733 Return = ok | {exception, _}
734 Sets the type_def attribute, an IFR Object of the type IDLType
736 describing the result.
737 get_params(Objref) -> Return
739 Types:
741 Objref = #IFR_OperationDef_objref
743 Return = list() (list of parameter description records)
744 Returns a list of parameter description records, which describes
746 the parameters of the OperationDef.
747 set_params(Objref,Params) -> Return
749 Types:
751 Objref = #IFR_OperationDef_objref
753 Params = list() (list of parameter description records)
754 Return = ok | {exception, _}
755 Sets the params attribute, a list of parameter description
757 records.
758 get_contexts(Objref) -> Return
760 Types:
762 Objref = #IFR_OperationDef_objref
764 Return = list() (list of strings)
765 Returns a list of context identifiers for the operation.
767 set_contexts(Objref,Contexts) -> Return
769 Types:
771 Objref = #IFR_OperationDef_objref
773 Contexts = list() (list of strings)
774 Return = ok | {exception, _}
775 Sets the context attribute for the operation.
777 get_exceptions(Objref) -> Return
779 Types:
781 Objref = #IFR_OperationDef_objref
783 Return = list() (list of #IFR_ExceptionDef_objrefs)
784 Returns a list of exception types that can be raised by this op‐
786 eration.
787 set_exceptions(Objref,Exceptions) -> Return
789 Types:
791 Objref = #IFR_OperationDef_objref
793 Exceptions = list() (list of #IFR_ExceptionDef_objrefs)
794 Return = ok | {exception, _}
795 Sets the exceptions attribute for this operation.
797 get_base_interfaces(Objref) -> Return
799 Types:
801 Objref = #IFR_InterfaceDef_objref
803 Return = list() (list of #IFR_InterfaceDef_objrefs)
804 Returns a list of InterfaceDefs from which this InterfaceDef in‐
806 herits.
807 set_base_interfaces(Objref,BaseInterfaces) -> Return
809 Types:
811 Objref = #IFR_InterfaceDef_objref
813 BaseInterfaces = list() (list of #IFR_InterfaceDef_objrefs)
814 Return = ok | {exception, _}
815 Sets the BaseInterfaces attribute.
817 is_a(Objref,Interface_id) -> Return
819 Types:
821 Objref = #IFR_InterfaceDef_objref
823 Interface_id = #IFR_InterfaceDef_objref
824 Return = atom() (true or false)
825 Returns true if the InterfaceDef either is identical to or in‐
827 herits from Interface_id.
828 describe_interface(Objref) -> Return
830 Types:
832 Objref = #IFR_InterfaceDef_objref
834 Return = tuple() (a fullinterfacedescription record)
835 Returns a full inter face description record describing the In‐
837 terfaceDef.
838 create_attribute(Objref,Id,Name,Version,Type,Mode) -> Return
840 Types:
842 Objref = #IFR_InterfaceDef_objref
844 Id = string()
845 Name = string()
846 Version = string()
847 Type = #IFR_IDLType_objref
848 Mode = atom() ('ATTR_NORMAL' or 'ATTR_READONLY')
849 Return = #IFR_AttributeDef_objref
850 Creates an IFR object of the type AttributeDef contained in this
852 InterfaceDef.
853 create_operation(Objref,Id,Name,Version,Result,Mode,Params, Excep‐
855 tions,Contexts) -> Return
856 Types:
858 Objref = #IFR_InterfaceDef_objref
860 Id = string()
861 Name = string()
862 Version = string()
863 Result = #IFR_IDLType_objref
864 Mode = atom() ('OP_NORMAL' or 'OP_ONEWAY')
865 Params = list() (list of parameter description records)
866 Exceptions = list() (list of #IFR_ExceptionDef_objrefs)
867 Contexts = list() (list of strings)
868 Return = #IFR_OperationDef_objref
869 Creates an IFR object of the type OperationDef contained in this
871 InterfaceDef.
872Ericsson AB orber 5.0.2 orber_ifr(3)