Module interface declaration

It is possible to generate a specification of the interfaces for one module. This is not useful for the framework itself, but it can be useful for an application which embeds the framework, such as a Framework Owner.

Grammar

See the grammar for the associated schema.

Structure

The structure of the interfaces specifications contains:

• The list of types used by the Module. The structure of the types declaration is identical to the data types configuration
• The list of services on input or output of the Module. The structure of the types declaration is very similar to the services configuration

Services

The XML element which declares the service depend on the Service type. The inOut attribute also specified if the Service is invoked by the module, or if the module is subsribed to the Service^[1]

The intOut value specifies that the module invoke the Service, but is also a subscriber of the Service

.

• For a publish Service: a publish element. For example: <publish name="position" id="1" inOut="in" >
• For an event Service: an event element. For example: <event name="directTo" id="1" inOut="out" >
• For a request-response Service: a requestResponse element. For example: <requestResponse name="computeFlightPlan" inOut="in" id="1" >

The content of the Service is identical as for the services configuration declaration.

Example

Suppose the configuration for the first tutorial. If we generate the interfaces for the EventModule:

      <protoInterfaces application="eventAppli" module="EventModule">
         <types>
            <simpleType name="bool" baseType="boolean" />
            <simpleType name="int" baseType="int" />
         </types>
         <services>
            <event name="event" inOut="out" id="1">
               <data name="event" type="bool" />
            </event>
            <publish name="published" inOut="in" id="2">
               <data name="value" type="int" />
            </publish>
         </services>
      </protoInterfaces>