<!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_webservice::CommandWebservice Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00260.html">module_webservice</a>::<a class="el" href="a00038.html">CommandWebservice</a>
</div>
</div>
<div class="contents">
<h1>module_webservice::CommandWebservice Class Reference</h1><!-- doxytag: class="module_webservice::CommandWebservice" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command runs a multi-threaded SOAP webservice server.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00221_source.html">module.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for module_webservice::CommandWebservice:</div>
<div class="dynsection">
<div class="center"><img src="a00687.png" border="0" usemap="#module__webservice_1_1_command_webservice_inherit__map" alt="Inheritance graph"/></div>
<map name="module__webservice_1_1_command_webservice_inherit__map" id="module__webservice_1_1_command_webservice_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="60,6,217,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00688.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>thread_data</b></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ace4533ee13439a66366811dd8e7f8052">CommandWebservice</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a464de63f22b18d0b19a49af0ebe5b28c">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a233ba097fa42c0fa5e5a2894d6a9b623">getDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a1800e4d81a9631800d57317e832e593f">~CommandWebservice</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#af1a86d48d12dc3dd63141dadb4639dc5">getPort</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a530abe6141b68f7d8c82575efe49e4f6">getThreads</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a830ac29dd87f66c8390661c6115f7e43">pythonService</a> (PyObject *, PyObject *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#af5db9b7ba3bc713830533902e854ab91">setPort</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a905db982056e843dfc7f873c20084898">setThreads</a> (int i)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command runs a multi-threaded SOAP webservice server. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00063">63</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ace4533ee13439a66366811dd8e7f8052"></a><!-- doxytag: member="module_webservice::CommandWebservice::CommandWebservice" ref="ace4533ee13439a66366811dd8e7f8052" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">module_webservice::CommandWebservice::CommandWebservice </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00108">108</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1800e4d81a9631800d57317e832e593f"></a><!-- doxytag: member="module_webservice::CommandWebservice::~CommandWebservice" ref="a1800e4d81a9631800d57317e832e593f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual module_webservice::CommandWebservice::~CommandWebservice </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00111">111</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a464de63f22b18d0b19a49af0ebe5b28c"></a><!-- doxytag: member="module_webservice::CommandWebservice::execute" ref="a464de63f22b18d0b19a49af0ebe5b28c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_webservice::CommandWebservice::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Runs the webservice server. </p>
<p>Implements <a class="el" href="a00025.html#acc6f6bc4f9a9ce8cfa2de41fd12f3024">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00236_source.html#l00056">56</a> of file <a class="el" href="a00236_source.html">server.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a233ba097fa42c0fa5e5a2894d6a9b623"></a><!-- doxytag: member="module_webservice::CommandWebservice::getDescription" ref="a233ba097fa42c0fa5e5a2894d6a9b623" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string module_webservice::CommandWebservice::getDescription </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a descriptive string. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00105">105</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<a class="anchor" id="af1a86d48d12dc3dd63141dadb4639dc5"></a><!-- doxytag: member="module_webservice::CommandWebservice::getPort" ref="af1a86d48d12dc3dd63141dadb4639dc5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned int module_webservice::CommandWebservice::getPort </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the port number. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00114">114</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<a class="anchor" id="a530abe6141b68f7d8c82575efe49e4f6"></a><!-- doxytag: member="module_webservice::CommandWebservice::getThreads" ref="a530abe6141b68f7d8c82575efe49e4f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned int module_webservice::CommandWebservice::getThreads </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of threads for the server. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00125">125</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<a class="anchor" id="a830ac29dd87f66c8390661c6115f7e43"></a><!-- doxytag: member="module_webservice::CommandWebservice::pythonService" ref="a830ac29dd87f66c8390661c6115f7e43" args="(PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * module_webservice::CommandWebservice::pythonService </td>
<td>(</td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Python interface for the webservice server. </p>
<p>Definition at line <a class="el" href="a00236_source.html#l00039">39</a> of file <a class="el" href="a00236_source.html">server.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af5db9b7ba3bc713830533902e854ab91"></a><!-- doxytag: member="module_webservice::CommandWebservice::setPort" ref="af5db9b7ba3bc713830533902e854ab91" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void module_webservice::CommandWebservice::setPort </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the port number. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00117">117</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<a class="anchor" id="a905db982056e843dfc7f873c20084898"></a><!-- doxytag: member="module_webservice::CommandWebservice::setThreads" ref="a905db982056e843dfc7f873c20084898" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void module_webservice::CommandWebservice::setThreads </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the number of threads for the server. </p>
<p>Definition at line <a class="el" href="a00221_source.html#l00128">128</a> of file <a class="el" href="a00221_source.html">module.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00221_source.html">module.h</a></li>
<li><a class="el" href="a00220_source.html">webservice/module.cpp</a></li>
<li><a class="el" href="a00236_source.html">server.cpp</a></li>
</ul>
</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>
