User's Guide

Version 4.4.2


4 Using the Plain Erlang Back-end

4.1  Introduction

The mapping of OMG IDL to the Erlang programming language when Plain Erlang is the back-end of choice is similar to the one used in pure Erlang IDL mapping. The only difference is on the generated code and the extended use of pragmas for code generation: IDL functions are translated to Erlang module function calls.

4.2  Compiling the Code

In the Erlang shell type :

ic:gen(<filename>, [{be, erl_plain}]).

4.3  Writing the Implementation File

For each IDL interface <interface name> defined in the IDL file:

  • Create the corresponding Erlang file that will hold the Erlang implementation of the IDL definitions.
  • Call the implementation file after the scope of the IDL interface, followed by the suffix _impl.
  • Export the implementation functions.

For each function defined in the IDL interface :

  • 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.
  • When using the function, follow the mapping described in chapter 2.

4.4  An Example

In this example, a file "random.idl" is generates code for the plain Erlang back-end :

  • Main file : "plain.idl"

    module rmod {
      interface random {
        double produce();
        oneway void init(in long seed1, in long seed2, in long seed3);

Compile the file :

      Erlang (BEAM) emulator version 4.9
      Eshell V4.9  (abort with ^G)
      1> ic:gen(random,[{be, erl_plain}]).
      Erlang IDL compiler version 2.5.1

When the file "random.idl" is compiled it produces five files: 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 only the file for the interface rmod_random.erl is important :.

  • Erlang file for interface : "rmod_random.erl"

    %% Interface functions
    -export([produce/0, init/3]).
    %% Operation: produce
    %%   Returns: RetVal
    produce() ->
    %% Operation: init
    %%   Returns: RetVal
    init(Seed1, Seed2, Seed3) ->
        rmod_random_impl:init(Seed1, Seed2, Seed3).

The implementation file should be called rmod_random_impl.erl and could look like this:

      produce()  ->
      init(S1,S2,S3)  ->

Compiling the code :

2> make:all().
Recompile: rmod_random
Recompile: oe_random
Recompile: rmod_random_impl

Running the example :

3>  rmod_random:init(1,2,3).
4>  rmod_random:produce().