Erlang -- orber_tc

orber

Reference Manual

Version 3.8.4

- User's Guide
- Reference Manual
- Release Notes
- PDF
- Top

- Expand All
- Contract All

### Table of Contents

- any
  - Top of manual page
  - create/0
  - create/2
  - get_typecode/1
  - get_value/1
  - set_typecode/2
  - set_value/2
- fixed
  - Top of manual page
  - add/2
  - create/3
  - divide/2
  - get_typecode/1
  - multiply/2
  - subtract/2
  - unary_minus/1
- corba
  - Top of manual page
  - add_alternate_iiop_address/3
  - add_initial_service/2
  - create/2
  - create/3
  - create/4
  - create_link/2
  - create_link/3
  - create_link/4
  - create_nil_objref/0
  - create_subobject_key/2
  - dispose/1
  - get_pid/1
  - get_subobject_key/1
  - list_initial_services/0
  - list_initial_services_remote/1
  - list_initial_services_remote/2
  - object_to_string/1
  - orb_init/1
  - print_object/1
  - raise/1
  - remove_initial_service/1
  - reply/2
  - resolve_initial_references/1
  - resolve_initial_references/2
  - resolve_initial_references_remote/2
  - resolve_initial_references_remote/3
  - string_to_object/1
  - string_to_object/2
- corba_object
  - Top of manual page
  - get_interface/1
  - hash/2
  - is_a/2
  - is_a/3
  - is_equivalent/2
  - is_nil/1
  - is_remote/1
  - non_existent/1
  - non_existent/2
  - not_existent/1
  - not_existent/2
- orber
  - Top of manual page
  - activate_audit_trail/0
  - activate_audit_trail/1
  - add_listen_interface/2
  - add_listen_interface/3
  - add_listen_interface/3
  - add_node/2
  - close_connection/1
  - close_connection/2
  - configure/2
  - deactivate_audit_trail/0
  - domain/0
  - exception_info/1
  - get_ORBDefaultInitRef/0
  - get_ORBInitRef/0
  - get_tables/0
  - iiop_acl/0
  - iiop_connection_timeout/0
  - iiop_connections/0
  - iiop_connections/1
  - iiop_connections_pending/0
  - iiop_in_connection_timeout/0
  - iiop_out_ports/0
  - iiop_out_ports_attempts/0
  - iiop_out_ports_random/0
  - iiop_port/0
  - iiop_ssl_port/0
  - iiop_timeout/0
  - info/0
  - info/1
  - install/1
  - install/2
  - is_system_exception/1
  - jump_start/1
  - objectkeys_gc_time/0
  - orber_nodes/0
  - remove_listen_interface/1
  - remove_node/1
  - secure/0
  - set_ssl_client_options/1
  - ssl_client_options/0
  - ssl_server_options/0
  - start/0
  - start/1
  - stop/0
  - uninstall/0
- orber_ifr
  - Top of manual page
  - contents/3
  - create_alias/5
  - create_array/3
  - create_attribute/6
  - create_constant/6
  - create_enum/5
  - create_exception/5
  - create_fixed/3
  - create_idltype/2
  - create_interface/5
  - create_module/4
  - create_operation/9
  - create_sequence/3
  - create_string/2
  - create_struct/5
  - create_union/6
  - create_wstring/2
  - describe/1
  - describe_contents/4
  - describe_interface/1
  - destroy/1
  - find_repository/0
  - get_absolute_name/1
  - get_base_interfaces/1
  - get_bound/1
  - get_containing_repository/1
  - get_contexts/1
  - get_def_kind/1
  - get_defined_in/1
  - get_discriminator_type/1
  - get_discriminator_type_def/1
  - get_element_type/1
  - get_element_type_def/1
  - get_exceptions/1
  - get_id/1
  - get_kind/1
  - get_length/1
  - get_members/1
  - get_mode/1
  - get_name/1
  - get_original_type_def/1
  - get_params/1
  - get_primitive/2
  - get_result/1
  - get_result_def/1
  - get_type/1
  - get_type_def/1
  - get_value/1
  - get_version/1
  - init/2
  - is_a/2
  - lookup/2
  - lookup_id/2
  - lookup_name/5
  - move/4
  - set_base_interfaces/2
  - set_bound/2
  - set_contexts/2
  - set_discriminator_type_def/2
  - set_element_type_def/2
  - set_exceptions/2
  - set_id/2
  - set_length/2
  - set_members/2
  - set_mode/2
  - set_name/2
  - set_original_type_def/2
  - set_params/2
  - set_result_def/2
  - set_type_def/2
  - set_value/2
  - set_version/2
- orber_tc
  - Top of manual page
  - alias/3
  - any/0
  - array/2
  - boolean/0
  - char/0
  - check_tc/1
  - double/0
  - enum/3
  - exception/3
  - fixed/2
  - float/0
  - get_tc/1
  - get_tc/1
  - long/0
  - long_long/0
  - null/0
  - object_reference/2
  - octet/0
  - principal/0
  - sequence/2
  - short/0
  - string/1
  - struct/3
  - typecode/0
  - union/5
  - unsigned_long/0
  - unsigned_long_long/0
  - unsigned_short/0
  - void/0
  - wchar/0
  - wstring/1
- orber_acl
  - Top of manual page
  - match/2
  - match/3
  - range/2
  - verify/3
- CosNaming
- CosNaming_NamingContext
  - Top of manual page
  - bind/3
  - bind_context/3
  - bind_new_context/2
  - destroy/1
  - list/2
  - new_context/1
  - rebind/3
  - rebind_context/3
  - resolve/2
  - unbind/2
- CosNaming_NamingContextExt
  - Top of manual page
  - resolve_str/2
  - to_name/2
  - to_string/2
  - to_url/3
- CosNaming_BindingIterator
  - Top of manual page
  - destroy/1
  - next_n/2
  - next_one/1
- lname
  - Top of manual page
  - create/0
  - delete_component/2
  - equal/2
  - from_idl_form/1
  - get_component/2
  - insert_component/3
  - less_than/2
  - num_component/1
  - to_idl_form/1
- lname_component
  - Top of manual page
  - create/0
  - get_id/1
  - get_kind/1
  - set_id/2
  - set_kind/2
- Module_Interface
  - Top of manual page
  - Module_Interface:oe_create/0
  - Module_Interface:oe_create/1
  - Module_Interface:oe_create/2
  - Module_Interface:oe_create_link/0
  - Module_Interface:oe_create_link/1
  - Module_Interface:oe_create_link/2
  - Module_Interface:own_functions/4
  - Module_Interface:own_functions/5
  - Module_Interface:typeID/0
  - Module_Interface_impl:code_change/3
  - Module_Interface_impl:handle_info/2
  - Module_Interface_impl:init/1
  - Module_Interface_impl:own_functions/4
  - Module_Interface_impl:own_functions/5
  - Module_Interface_impl:own_functions/6
  - Module_Interface_impl:own_functions/5
  - Module_Interface_impl:own_functions/4
  - Module_Interface_impl:own_functions/5
  - Module_Interface_impl:terminate/2
- interceptors
  - Top of manual page
  - closed_in_connection/1
  - closed_out_connection/1
  - in_reply/6
  - in_reply_encoded/6
  - in_request/6
  - in_request_encoded/6
  - new_in_connection/3
  - new_in_connection/5
  - new_out_connection/3
  - new_out_connection/5
  - out_reply/6
  - out_reply_encoded/6
  - out_request/6
  - out_request_encoded/6
- orber_diagnostics
  - Top of manual page
  - missing_modules/0
  - nameservice/0
  - nameservice/1

# orber_tc

### Module

orber_tc

### Module Summary

Help functions for IDL typecodes

### Description

This module contains some functions that gives support in creating IDL typecodes that can be used in for example the any types typecode field. For the simple types it is meaningless to use this API but the functions exist to get the interface complete.

The type TC used below describes an IDL type and is a tuple according to the to the Erlang language mapping.

### Exports

null() -> TC
void() -> TC
short() -> TC
unsigned_short() -> TC
long() -> TC
unsigned_long() -> TC
long_long() -> TC
unsigned_long_long() -> TC
wchar() -> TC
float() -> TC
double() -> TC
boolean() -> TC
char() -> TC
octet() -> TC
any() -> TC
typecode() -> TC
principal() -> TC

These functions return the IDL typecodes for simple types.

object_reference(Id, Name) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the object

Function returns the IDL typecode for object_reference.

struct(Id, Name, ElementList) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the struct
ElementList = [{MemberName, TC}]
a list of the struct elements
MemberName = string()
the element name

Function returns the IDL typecode for struct.

union(Id, Name, DiscrTC, Default, ElementList) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the union
DiscrTC = TC
the typecode for the unions discriminant
Default = integer()
a value that indicates which tuple in the element list that is default (value < 0 means no default)
ElementList = [{Label, MemberName, TC}]
a list of the union elements
Label = term()
the label value should be of the DiscrTCtype
MemberName = string()
the element name

Function returns the IDL typecode for union.

enum(Id, Name, ElementList) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the enum
ElementList = [MemberName]
a list of the enums elements
MemberName = string()
the element name

Function returns the IDL typecode for enum.

string(Length) -> TC

### Types

Length = integer()
the length of the string (0 means unbounded)

Function returns the IDL typecode for string.

wstring(Length) -> TC

### Types

Length = integer()
the length of the wstring (0 means unbounded)

Function returns the IDL typecode for wstring.

fixed(Digits, Scale) -> TC

### Types

Digits = Scale = integer()
the digits and scale parameters of a Fixed type

Function returns the IDL typecode for fixed.

sequence(ElemTC, Length) -> TC

### Types

ElemTC = TC
the typecode for the sequence elements
Length = integer()
the length of the sequence (0 means unbounded)

Function returns the IDL typecode for sequence.

array(ElemTC, Length) -> TC

### Types

ElemTC = TC
the typecode for the array elements
Length = integer()
the length of the array

Function returns the IDL typecode for array.

alias(Id, Name, AliasTC) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the alias
AliasTC = TC
the typecode for the type which the alias refer to

Function returns the IDL typecode for alias.

exception(Id, Name, ElementList) -> TC

### Types

Id = string()
the repository ID
Name = string()
the type name of the exception
ElementList = [{MemberName, TC}]
a list of the exception elements
MemberName = string()
the element name

Function returns the IDL typecode for exception.

get_tc(Object) -> TC
get_tc(Id) -> TC

### Types

Object = record()
an IDL specified struct, union or exception
Id = string()
the repository ID

If the get_tc/1 gets a record that is and IDL specified struct, union or exception as a parameter it returns the typecode.

If the parameter is a repository ID it uses the Interface Repository to get the typecode.

check_tc(TC) -> boolean()

Function checks the syntax of an IDL typecode.