cosnaming(3erl) [linux man page]

CosNaming(3erl) 					     Erlang Module Definition						   CosNaming(3erl)

NAME

       CosNaming - The CosNaming service is a collection of interfaces that together define the naming service.

DESCRIPTION

       The  naming service provides the principal mechanism for clients to find objects in an ORB based world. The naming service provides an ini-
       tial naming context that functions as the root context for all names. Given this context clients can navigate in the name space.

       Types that are declared on the CosNaming level are:

       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;

       To get access to the record definitions for the structs use: -include_lib("orber/COSS/CosNaming.hrl"). .

       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.

       There are two different interfaces supported in the service:

	 * NamingContext

	 * BindingIterator

Ericsson AB							   orber 3.6.20 						   CosNaming(3erl)

CosNaming_BindingIterator(3erl) 			     Erlang Module Definition				   CosNaming_BindingIterator(3erl)

NAME

       CosNaming_BindingIterator - This interface supports iteration over a name binding list.

DESCRIPTION

       This interface allows a client to iterate over the Bindinglist it has been initiated with.

       The type NameComponent used below is defined as:

	     -record('CosNaming_NameComponent', {id, kind=""}).

       id and kind are strings.

       The type Binding used below is defined as:

	     -record('CosNaming_Binding', {binding_name, binding_type}).

       binding_name is a Name = [NameComponent] and binding_type is an enum which has the values nobject and ncontext .

       Both these records are defined in the file CosNaming.hrl and it is included with:

	     -include_lib("orber/COSS/CosNaming/CosNaming.hrl").

EXPORTS

       next_one(BindinIterator) -> Return

	      Types  BindingIterator = #objref
		     Return = {bool(), Binding}

	      This  operation  returns	the  next binding and a boolean. The latter is set to true if the binding is valid otherwise false. If the
	      boolean is false there are no more bindings to retrieve.

       next_n(BindinIterator, HowMany) -> Return

	      Types  BindingIterator = #objref
		     HowMany = int()
		     BindingList = [Binding]
		     Return = {bool(), BindingList}

	      This operation returns a binding list with at most HowMany bindings. If there are no more bindings it returns false otherwise true.

       destroy(BindingIterator) -> Return

	      Types  BindingIterator = #objref
		     Return = ok

	      This operation destroys the binding iterator.

Ericsson AB							   orber 3.6.20 				   CosNaming_BindingIterator(3erl)