aboutsummaryrefslogtreecommitdiffstats
path: root/lib/orber/doc/src/CosNaming.xml
blob: e8c639b59ac595e04539c03098a80b04f7baab7d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>1997</year><year>2010</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

    </legalnotice>

    <title>CosNaming</title>
    <prepared></prepared>
    <docno></docno>
    <checked></checked>
    <date>1997-06-10</date>
    <rev>A</rev>
  </header>
  <module>CosNaming</module>
  <modulesummary>The CosNaming service is a collection of interfaces that together define the naming service.</modulesummary>
  <description>
    <p>The naming service provides  the principal mechanism for clients to find 
      objects in an ORB based world. The naming service provides an initial naming
      context that functions as the root context for all names. Given this context 
      clients can navigate in the name space. </p>
    <p>Types that are declared on the CosNaming level are:</p>
    <code type="none"><![CDATA[
typedef string Istring;
struct NameComponent {
      Istring id;  
      Istring kind;
};
  
typedef sequence <NameComponent> Name;
  
enum BindingType {nobject, ncontext};
  
struct Binding {
      Name    binding_name;
      BindingType binding_type;
};

typedef sequence <Binding> BindingList;
    ]]></code>
    <p>To get access to the record definitions for the structs use:
      <c>-include_lib("orber/COSS/CosNaming.hrl").</c>.</p>
    <p>Names are not an ORB object but the can be structured in components as seen by 
      the definition above. There are no requirements on names so the service can support 
      many different conventions and standards.</p>
    <p>There are two different interfaces supported in the service:</p>
    <list type="bulleted">
      <item>NamingContext</item>
      <item>BindingIterator</item>
    </list>
  </description>
  
</erlref>