File: ch_erl_genserv.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (269 lines) | stat: -rw-r--r-- 6,791 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>Using the Erlang Generic Server Back-end</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<CENTER>
<A HREF="http://www.erlang.se"><IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif"></A>
</CENTER>
<A NAME="5"><!-- Empty --></A>
<H2>5 Using the Erlang Generic Server Back-end</H2>
<A NAME="5.1"><!-- Empty --></A>
<H3>5.1 Introduction</H3>

<P> The mapping of OMG IDL to the Erlang programming language when Erlang 
generic server is the back-end of choice is similar to the one used in
the chapter 'OMG IDL Mapping'.
The only difference is in the generated code, a client stub and
server skeleton to an Erlang <CODE>gen_server</CODE>. Orber's User's Guide
contain a more detailed description of IDL to Erlang mapping.
<A NAME="5.2"><!-- Empty --></A>
<H3>5.2 Compiling the Code</H3>

<P>The <CODE>ic:gen/2</CODE> function can be called from the command 
line as follows:
<P> 
<PRE>
shell&#62; erlc &#34;+{be, erl_genserv}&#34; MyFile.idl
    
</PRE>
<A NAME="5.3"><!-- Empty --></A>
<H3>5.3 Writing the Implementation File</H3>

<P> For each IDL interface <CODE>&#60;interface name&#62;</CODE> defined in the IDL file :

<P>
<UL>

<LI>
        Create the coresponding Erlang file that will hold the
        Erlang implementation of the IDL definitions. 

</LI>


<LI>
        Call the implementation file after the scope of the IDL interface, 
        followed by the suffix <CODE>_impl</CODE>.

</LI>


<LI>
        Export the implementation functions.

</LI>


</UL>

<P> For each function defined in the IDL interface :

<P>
<UL>

<LI>
        Implement an Erlang function that uses as arguments in the same
order, as the input arguments described in the IDL file, and returns 
the value described in the interface.

</LI>


<LI>
        When using the function, follow the mapping described in chapter 2.

</LI>


</UL>
<A NAME="5.4"><!-- Empty --></A>
<H3>5.4 An Example</H3>

<P>In this example, a file <CODE>random.idl</CODE> generates code for the erlang
gen_server back-end:
<PRE>
// Filename random.idl  
module rmod {
 
  interface random {
    // Generate a new random number 
    double produce();
    // Initialize random generator
    oneway void init(in long seed1, in long seed2, in long seed3);
 
  };
};
        
</PRE>

<P> When the file &#34;random.idl&#34; is compiled (e.g., <CODE>shell&#62; erlc &#34;+{be, erl_genserv}&#34; random.idl</CODE>)
five files are produced; two for the top scope, two for the interface scope,
and one for the module scope. The header files for top scope and interface
are empty and not shown here. In this case, the stub/skeleton file 
<CODE>rmod_random.erl</CODE> is the most important. This module exports two kinds of
operations:

<P>
<UL>

<LI>
<STRONG>Administrative</STRONG> - used when, for example, creating and
terminating the server.
</LI>


<LI>
<STRONG>IDL dependent</STRONG> - operations defined in the IDL 
specification. In this case, <CODE>produce</CODE> and <CODE>init</CODE>.
</LI>


</UL>
<A NAME="5.4.1"><!-- Empty --></A>
<H4>5.4.1 Administrative Operations</H4>

<P>To create a new server instance, one of the following functions should
be used:
<P>
<UL>

<LI>
<STRONG>oe_create/0/1/2</STRONG> - create a new instance of the object.
Accepts <CODE>Env</CODE> and <CODE>RegName</CODE>, in that order, as parameters.
The former is passed uninterpreted to the initialization operation
of the call-back module, while the latter must be as the
<CODE>gen_server</CODE> parameter <CODE>ServerName</CODE>. If <CODE>Env</CODE> is
left out, an empty list will be passed.
</LI>


<LI>
<STRONG>oe_create_link/0/1/2</STRONG> - similar to <CODE>oe_create/0/1/2</CODE>, 
but create a linked server.
</LI>


<LI>
<STRONG>typeID/0</STRONG> - returns the scooped id compliant with the
OMG standard. In this case the string 
<CODE>&#34;IDL:rmod/random:1.0&#34;</CODE>.
</LI>


<LI>
<STRONG>stop/1</STRONG> - asynchronously terminate the server. The required
argument is the return value from any of the start functions.
</LI>


</UL>
<A NAME="5.4.2"><!-- Empty --></A>
<H4>5.4.2 IDL Dependent Operations</H4>

<P>Operations can either be synchronous or asynchronous 
(i.e., <CODE>oneway</CODE>). These are, respectively, mapped to 
<CODE>gen_server:call/2/3</CODE> and <CODE>gen_server:cast/2</CODE>. 
Consult the <CODE>gen_server</CODE> documentation for valid return values.

<P>The IDL dependent operations in this example are listed below. 
The first argument must be the whatever the create operation returned.
<P>
<UL>

<LI>
<STRONG>init(ServerReference, Seed1, Seed2, Seed3)</STRONG> - initialize 
the random number generator.
</LI>


<LI>
<STRONG>produce(ServerReference)</STRONG> - generate a new random number.
</LI>


</UL>

<P>If the compile option <CODE>timeout</CODE> is used a timeout must be added 
(e.g., <CODE>produce(ServerReference, 5000)</CODE>). For more information, see
the <CODE>gen_server</CODE> documentation.<A NAME="5.4.3"><!-- Empty --></A>
<H4>5.4.3 Implementation Module</H4>

<P>The implementation module shall, unless the compile option
<CODE>impl</CODE> is used, be named <CODE>rmod_random_impl.erl</CODE>.
and could look like this:

<PRE>
-module('rmod_random_impl').
%% Mandatory gen_server operations
-export([init/1, terminate/2, code_change/3]).
%% Add if 'handle_info' compile option used
-export([handle_info/2]).
%% API defined in IDL specification
-export([produce/1,init/4]).

%% Mandatory operations
init(Env) -&#62;
    {ok, []}.

terminate(From, Reason) -&#62;
    ok.

code_change(OldVsn, State, Extra) -&#62;
    {ok, State}.

%% Optional
handle_info(Info, State) -&#62;
    {noreply, NewState}.

%% IDL specification
produce(State)  -&#62;
    case catch random:uniform() of
        {'EXIT',_} -&#62;
            {stop, normal, &#34;random:uniform/0 - EXIT&#34;, State};
        RUnif -&#62;
            {reply, RUnif, State}
     end.


init(State, S1, S2, S3)  -&#62;
    case catch random:seed(S1, S2, S3) of
        {'EXIT',_} -&#62;
            {stop, normal, State};
        _ -&#62;
            {noreply, State}
    end.

    
</PRE>

<P>Compile the code and run the example:
<PRE>
1&#62; make:all().
Recompile: rmod_random
Recompile: oe_random
Recompile: rmod_random_impl
up_to_date
2&#62; {ok,R} = rmod_random:oe_create().
{ok,&#60;0.30.0&#62;}
3&#62; rmod_random:init(R, 1, 2, 3).
ok
4&#62; rmod_random:produce(R).
1.97963e-4
5&#62; 
      
</PRE>
<CENTER>
<HR>
<SMALL>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>