X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=doc%2Findex.doc;h=6a4accb7a34dffc6e90d30a7ff4c4c778ad513c4;hp=b9caffafcd7f9f7734b8835a434103bdb832d59c;hb=e8b2809dd8681076434fc2b7cb54b148c3b1cbcb;hpb=3e11fd2cfda1d68b7bc825ae5c10515f4a8b7f86 diff --git a/doc/index.doc b/doc/index.doc index b9caffa..6a4accb 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -17,11 +17,12 @@ The input for the code generator is standard C++ code \ref notes4 "[4]" and you mark the procedures you want to expose to other processes. Because the interface is described in C++ directly there is no need for a interface description language (IDL, \ref notes5 "[5]"). - It then generates the client and server stubs needed. - \par - The exported procedures can be grouped. Each group maps to two classes (cmd_group_... and cmd_group_..._client) where the cmd_group_..._client class provides the interface to call remote procedures. Each remote procedure maps to a method of this class and the constructor takes a connection object establishing the binding to the remote side. For each group the code generator is called and generates 6 output files: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files contain the client stub code (the cmd_group_..._client class) and the _server files the server stub code. + The code generator is used to create the client and server stubs for the marked procedures. The procedures can be grouped and each group maps to two classes (cmd_group_... and cmd_group_..._client). The cmd_group_..._client class provides the interface to call remote procedures. Each remote procedure maps to a method of this class and the constructor takes a connection object establishing the binding to the remote side. For each group the code generator is called and generates 6 output files: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files contain the client stub code (the cmd_group_..._client class) and the _server files the server stub code. \par To simplify the build process a Makefile snippet is provided that allows to create a server program and a client library (including a corresponding .pc file) using the autotools easily. + \section License + The libt2n libaray is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation. The code generator (libt2n-codegen) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + \section install_sec Installation \subsection requirements Requirements