<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: module.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_cfc6129efafb4deb1379318d01a4b532.html">modules</a> » <a class="el" href="dir_1fb731018ee43e669063132ba9c17b7b.html">webservice</a>
</div>
</div>
<div class="contents">
<h1>module.h</h1><a href="a00221.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> file : $URL: https://frepple.svn.sourceforge.net/svnroot/frepple/trunk/modules/webservice/module.h $</span>
<a name="l00003"></a>00003 <span class="comment"> version : $LastChangedRevision: 1108 $ $LastChangedBy: jdetaeye $</span>
<a name="l00004"></a>00004 <span class="comment"> date : $LastChangedDate: 2009-12-06 18:54:18 +0100 (Sun, 06 Dec 2009) $</span>
<a name="l00005"></a>00005 <span class="comment"> ***************************************************************************/</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">/***************************************************************************</span>
<a name="l00008"></a>00008 <span class="comment"> * *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2007 by Johan De Taeye *</span>
<a name="l00010"></a>00010 <span class="comment"> * *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is free software; you can redistribute it and/or modify it *</span>
<a name="l00012"></a>00012 <span class="comment"> * under the terms of the GNU Lesser General Public License as published *</span>
<a name="l00013"></a>00013 <span class="comment"> * by the Free Software Foundation; either version 2.1 of the License, or *</span>
<a name="l00014"></a>00014 <span class="comment"> * (at your option) any later version. *</span>
<a name="l00015"></a>00015 <span class="comment"> * *</span>
<a name="l00016"></a>00016 <span class="comment"> * This library is distributed in the hope that it will be useful, *</span>
<a name="l00017"></a>00017 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
<a name="l00018"></a>00018 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *</span>
<a name="l00019"></a>00019 <span class="comment"> * General Public License for more details. *</span>
<a name="l00020"></a>00020 <span class="comment"> * *</span>
<a name="l00021"></a>00021 <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span>
<a name="l00022"></a>00022 <span class="comment"> * License along with this library; if not, write to the Free Software *</span>
<a name="l00023"></a>00023 <span class="comment"> * Foundation Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 *</span>
<a name="l00024"></a>00024 <span class="comment"> * USA *</span>
<a name="l00025"></a>00025 <span class="comment"> * *</span>
<a name="l00026"></a>00026 <span class="comment"> ***************************************************************************/</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/** @file module.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Header file for the module webservice.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @namespace module_webservice</span>
<a name="l00032"></a>00032 <span class="comment"> * @brief A SOAP webservice to publish frePPLe data as a service.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * The gSOAP toolkit is used to create a SOAP service for frePPLe.</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> * A new Python extension is added to run a multi-threaded SOAP webservice</span>
<a name="l00037"></a>00037 <span class="comment"> * server.</span>
<a name="l00038"></a>00038 <span class="comment"> */</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="a00206.html" title="Public header file for C++.">frepple.h</a>"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="a00207.html" title="Public header file for C and C++.">freppleinterface.h</a>"</span>
<a name="l00042"></a>00042 <span class="keyword">using namespace </span>frepple;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#include "soapH.h"</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// Settings specific to gsoap</span>
<a name="l00048"></a><a class="code" href="a00221.html#aeefbbafa97642defe3ee6c3080b7d66f">00048</a> <span class="preprocessor">#define BACKLOG (100) // Max. number of backlog requests</span>
<a name="l00049"></a><a class="code" href="a00221.html#ab94814559b67e4a2a564087f821145ea">00049</a> <span class="preprocessor"></span><span class="preprocessor">#define MAX_QUEUE (1000) // Max. size of request queue</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">namespace </span>module_webservice
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">/** Initialization routine for the library. */</span>
<a name="l00057"></a>00057 <a class="code" href="a00252.html#a49d85811d1043ff1f3d7df4be3d90138">MODULE_EXPORT</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a00260.html#affa631a7e1b8fb8a6ec49526c26119ef">initialize</a>(<span class="keyword">const</span> <a class="code" href="a00030.html#abed9d8d8563f8322df35b7b9723d6f4f">CommandLoadLibrary::ParameterList</a>& z);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">/** @brief This command runs a multi-threaded SOAP webservice server.</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="a00038.html">00063</a> <span class="keyword">class </span><a class="code" href="a00038.html" title="This command runs a multi-threaded SOAP webservice server.">CommandWebservice</a> : <span class="keyword">public</span> <a class="code" href="a00025.html" title="Abstract base class for all commands.">Command</a>
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /** Port number for the server. */</span>
<a name="l00067"></a>00067 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> port;
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /** Number of threads to handle requests. */</span>
<a name="l00070"></a>00070 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> threads;
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Worker function for the threads. */</span>
<a name="l00073"></a>00073 <span class="keyword">static</span> <span class="keywordtype">void</span> *process_queue(<span class="keywordtype">void</span>*);
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** Put a new connection in the queue. */</span>
<a name="l00076"></a>00076 <span class="keywordtype">int</span> enqueue(SOAP_SOCKET);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Pick a connection from the queue. */</span>
<a name="l00079"></a>00079 SOAP_SOCKET dequeue();
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">struct </span>thread_data
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 <span class="keyword">public</span>:
<a name="l00084"></a>00084 <a class="code" href="a00038.html" title="This command runs a multi-threaded SOAP webservice server.">CommandWebservice</a>* master;
<a name="l00085"></a>00085 <span class="keyword">struct </span>soap *soap_thr; <span class="comment">// each thread needs a soap runtime environment</span>
<a name="l00086"></a>00086 pthread_t tid;
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index;
<a name="l00088"></a>00088 };
<a name="l00089"></a>00089
<a name="l00090"></a>00090
<a name="l00091"></a>00091 SOAP_SOCKET queue[<a class="code" href="a00221.html#ab94814559b67e4a2a564087f821145ea">MAX_QUEUE</a>]; <span class="comment">// The global request queue of sockets</span>
<a name="l00092"></a>00092 <span class="keywordtype">int</span> head;
<a name="l00093"></a>00093 <span class="keywordtype">int</span> tail; <span class="comment">// Queue head and tail</span>
<a name="l00094"></a>00094 pthread_mutex_t queue_cs;
<a name="l00095"></a>00095 pthread_cond_t queue_cv;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /** Python interface for the webservice server. */</span>
<a name="l00099"></a>00099 <span class="keyword">static</span> PyObject* <a class="code" href="a00038.html#a830ac29dd87f66c8390661c6115f7e43">pythonService</a>(PyObject*, PyObject*);
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Runs the webservice server. */</span>
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="a00038.html#a464de63f22b18d0b19a49af0ebe5b28c">execute</a>();
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /** Returns a descriptive string. */</span>
<a name="l00105"></a><a class="code" href="a00038.html#a233ba097fa42c0fa5e5a2894d6a9b623">00105</a> <span class="keywordtype">string</span> <a class="code" href="a00038.html#a233ba097fa42c0fa5e5a2894d6a9b623">getDescription</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="stringliteral">"frePPLe webservice"</span>;}
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment"> /** Default constructor. */</span>
<a name="l00108"></a><a class="code" href="a00038.html#ace4533ee13439a66366811dd8e7f8052">00108</a> <span class="keyword">explicit</span> <a class="code" href="a00038.html#ace4533ee13439a66366811dd8e7f8052">CommandWebservice</a>() : head(0), tail(0) {}
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment"> /** Destructor. */</span>
<a name="l00111"></a><a class="code" href="a00038.html#a1800e4d81a9631800d57317e832e593f">00111</a> <span class="keyword">virtual</span> <a class="code" href="a00038.html#a1800e4d81a9631800d57317e832e593f">~CommandWebservice</a>() {}
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment"> /** Returns the port number. */</span>
<a name="l00114"></a><a class="code" href="a00038.html#af1a86d48d12dc3dd63141dadb4639dc5">00114</a> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00038.html#af1a86d48d12dc3dd63141dadb4639dc5">getPort</a>() {<span class="keywordflow">return</span> port;}
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /** Updates the port number. */</span>
<a name="l00117"></a><a class="code" href="a00038.html#af5db9b7ba3bc713830533902e854ab91">00117</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="a00038.html#af5db9b7ba3bc713830533902e854ab91">setPort</a>(<span class="keywordtype">int</span> i)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="keywordflow">if</span> (i <= 0 || i>65535)
<a name="l00120"></a>00120 <span class="keywordflow">throw</span> <a class="code" href="a00048.html" title="An exception of this type is thrown when data errors are found.">DataException</a>(<span class="stringliteral">"Invalid port number: valid range is 1 - 65535"</span>);
<a name="l00121"></a>00121 port = i;
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment"> /** Returns the number of threads for the server. */</span>
<a name="l00125"></a><a class="code" href="a00038.html#a530abe6141b68f7d8c82575efe49e4f6">00125</a> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00038.html#a530abe6141b68f7d8c82575efe49e4f6">getThreads</a>() {<span class="keywordflow">return</span> threads;}
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment"> /** Updates the number of threads for the server. */</span>
<a name="l00128"></a><a class="code" href="a00038.html#a905db982056e843dfc7f873c20084898">00128</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="a00038.html#a905db982056e843dfc7f873c20084898">setThreads</a>(<span class="keywordtype">int</span> i)
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130 <span class="keywordflow">if</span> (i <= 0 || i>100)
<a name="l00131"></a>00131 <span class="keywordflow">throw</span> <a class="code" href="a00048.html" title="An exception of this type is thrown when data errors are found.">DataException</a>(<span class="stringliteral">"Invalid number of threads: valid range is 1 - 100"</span>);
<a name="l00132"></a>00132 threads = i;
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134 };
<a name="l00135"></a>00135
<a name="l00136"></a>00136
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
</pre></div></div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
