libApp

Browse Download file Permalink

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY firstname "Pierre">

<!ENTITY surname "Pronchery">

<!ENTITY username "khorben">

<!ENTITY email "khorben@defora.org">

<!ENTITY section "1">

<!ENTITY title "libApp User Manual">

<!ENTITY package "DeforaOS libApp">

<!ENTITY name "AppBroker">

<!ENTITY purpose "Broker for the App message-passing specification">

<title>&title;</title>

<productname>&package;</productname>

<firstname>&firstname;</firstname>

<surname>&surname;</surname>

<contrib>Code and documentation.</contrib>

<email>&email;</email>

</address>

</author>

</authorgroup>

<holder>&firstname; &surname; <&email;></holder>

</copyright>

<para>This manual page was written for the DeforaOS project (and may be

used by others).</para>

<para>Permission is granted to copy, distribute and/or modify this

document under the terms of the GNU General Public License,

Version 3 as published by the Free Software Foundation.</para>

</legalnotice>

</refentryinfo>

<manvolnum>&section;</manvolnum>

</refmeta>

<refpurpose>&purpose;</refpurpose>

</refnamediv>

<group>

</group>

<replaceable>output</replaceable></arg>

<arg choice="plain"><replaceable>filename</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<title>Description</title>

<para><command>&name;</command> is a broker for the App message-passing

protocol. It translates an interface definition file into a C header file,

suitable as a reference while implementing an AppServer.</para>

</refsect1>

<title>Options</title>

<para>&name; expects a specification file to be specified on the command line.

The following options are available:</para>

<para>Generate a file suitable for a client.</para>

</listitem>

</varlistentry>

<para>Generate a file suitable for a server. This is the default

behavior.</para>

</listitem>

</varlistentry>

<para>Output file.</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<title>Example</title>

<para>The following interface definition file:</para>

<programlisting>service=VFS

[call::chmod]

ret=INT32

arg1=STRING,pathname

arg2=UINT32,mode</programlisting>

<para>will likely be translated as follows for a server:</para>

<programlisting>/* $Id$ */

#ifndef VFS_VFS_H

# define VFS_VFS_H

# include <stdint.h>

# include <System/App.h>

/* types */

typedef Buffer * BUFFER;

typedef double * DOUBLE;

typedef float * FLOAT;

typedef int16_t INT16;

typedef int32_t INT32;

typedef uint16_t UINT16;

typedef uint32_t UINT32;

typedef String const * STRING;

typedef void VOID;

typedef BUFFER BUFFER_IN;

typedef DOUBLE DOUBLE_IN;

typedef FLOAT FLOAT_IN;

typedef INT32 INT32_IN;

typedef UINT32 UINT32_IN;

typedef STRING STRING_IN;

typedef Buffer * BUFFER_OUT;

typedef int32_t * INT32_OUT;

typedef uint32_t * UINT32_OUT;

typedef String ** STRING_OUT;

typedef Buffer * BUFFER_INOUT;

typedef int32_t * INT32_INOUT;

typedef uint32_t * UINT32_INOUT;

typedef String ** STRING_INOUT;

/* calls */

INT32 VFS_chmod(App * app, AppServerClient * client, STRING pathname, UINT32 mode);

#endif /* !VFS_VFS_H */</programlisting>

</refsect1>

<para>Issues can be listed and reported at <ulink

url="http://www.defora.org/os/project/bug_list/3564/libApp"/>.</para>

</refsect1>

<para>

<refentrytitle>AppClient</refentrytitle>

</citerefentry>

</para>

</refsect1>

</refentry>