lname(3erl) [linux man page]

lname(3erl)						     Erlang Module Definition						       lname(3erl)

NAME

       lname - Interface that supports the name pseudo-objects.

DESCRIPTION

       This interface is a part of the names library which is used to hide the representation of names. In Orbers Erlang mapping the pseudo-object
       names and the real IDL names have the same representation but it is desirable that the clients uses the names library so they will  not	be
       dependent of the representation. The lname interface supports handling of names e.g. adding and removing name components.

       Note  that  the lname interface in orber does not contain a destroy function because the Names are represented as standard Erlang lists and
       therefor will be removed by the garbage collector when not in use.

       The type NameComponent used below is defined as:

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

       id and kind are strings.

       The record is defined in the file CosNaming.hrl and it is included with:

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

EXPORTS

       create() -> Return

	      Types  Return = [NameComponent]

	      This function returns a new name.

       insert_component(Name, N, NameComponent) -> Return

	      Types  Name = [NameComponent]
		     N = int()
		     Return = Name

	      This function returns a name where the new name component has been inserted as component N in Name.

       get_component(Name, N) -> Return

	      Types  Name = [NameComponent]
		     N = int()
		     Return = NameComponent

	      This function returns the N:th name component in Name.

       delete_component(Name, N) -> Return

	      Types  Name = [NameComponent]
		     N = int()
		     Return = Name

	      This function deletes the N:th name component from Name and returns the new name.

       num_component(Name) -> Return

	      Types  Name = [NameComponent]
		     Return = int()

	      This function returns a the number of name components in Name.

       equal(Name1, Name2) -> Return

	      Types  Name1 = Name2 = [NameComponent]
		     Return = bool()

	      This function returns true if the two names are equal and false otherwise.

       less_than(Name1, Name2) -> Return

	      Types  Name1 = Name2 = [NameComponent]
		     Return = bool()

	      This function returns true if Name1 are lesser than Name2 and false otherwise.

       to_idl_form(Name) -> Return

	      Types  Name = [NameComponent]
		     Return = Name

	      This function just checks if Name is a correct IDL name before returning it because the name representation is the same  for  pseudo
	      and IDL names in orber.

       from_idl_form(Name) -> Return

	      Types  Name = [NameComponent]
		     Return = Name

	      This function just returns the Name because the name representation is the same for pseudo and IDL names in orber.

Ericsson AB							   orber 3.6.20 						       lname(3erl)

Check Out this Related Man Page

CosEventChannelAdmin_ProxyPullSupplier(3erl)		     Erlang Module Definition		      CosEventChannelAdmin_ProxyPullSupplier(3erl)

NAME

       CosEventChannelAdmin_ProxyPullSupplier  -  This module implements a ProxyPullSupplier interface which acts as a middleman between pull con-
       sumer and the event channel.

DESCRIPTION

       The ProxyPullSupplier interface defines the second step for connecting pull consumers to the event channel. A proxy supplier is similar	to
       a normal supplier, but includes an additional method for connecting a consumer to the proxy supplier.

       To get access to all definitions, e.g., exceptions, include necessary hrl files by using:
       -include_lib("cosEvent/include/*.hrl").

       Any object that possesses an object reference that supports the ProxyPullSupplier interface can perform the following operations:

EXPORTS

       connect_pull_consumer(Object, PullConsumer) -> Return

	      Types  Object = #objref
		     PullConsumer = #objref of PullConsumer type
		     Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}

	      This operation connects PullConsumer object to the ProxyPullSupplier object. A nil object reference can be passed to this operation.
	      If so a channel cannot invoke the disconnect_pull_consumer operation on the consumer; the consumer  may  be  disconnected  from  the
	      channel  without	being  informed.  If  the  ProxyPullSupplier  is  already connected to a PullConsumer, then the CosEventChannelAd-
	      min_AlreadyConnected exception is raised.

       disconnect_pull_supplier(Object) -> Return

	      Types  Object = #objref
		     Return = ok

	      This operation disconnects proxy pull supplier from the event channel. It sends a notification about the loss of the  connection	to
	      the pull consumer attached to it, unless nil object reference was passed at the connection time.

       pull(Object) -> Return

	      Types  Object = #objref
		     Return = any

	      This  operation  blocks until the event data is available or the CosEventComm_Disconnected exception is raised. It returns the event
	      data to the consumer.

       try_pull(Object) -> Return

	      Types  Object = #objref
		     Return = {any, bool()}

	      This operation does not block: if the event data is available, it returns the event data and sets  the  data  availability  flag	to
	      true;  otherwise	it  returns a long with an undefined value and sets the data availability to false. If the event communication has
	      already been disconnected, the CosEventComm_Disconnected exception is raised.

Ericsson AB							  cosEvent 2.1.10		      CosEventChannelAdmin_ProxyPullSupplier(3erl)

Linux and UNIX Man Pages

lname(3erl) [linux man page]

Check Out this Related Man Page