src/eric7/Documentation/Source/eric7.RemoteServer.EricServerBaseRequestHandler.html

branch
eric7
changeset 10784
521fd465b048
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.RemoteServer.EricServerBaseRequestHandler.html	Fri Jun 14 11:23:45 2024 +0200
@@ -0,0 +1,131 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.RemoteServer.EricServerBaseRequestHandler</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.RemoteServer.EricServerBaseRequestHandler</h1>
+<p>
+Module implementing the request handler base class of the eric-ide server.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#EricServerBaseRequestHandler">EricServerBaseRequestHandler</a></td>
+<td>Class implementing the request handler base class of the eric-ide server.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="EricServerBaseRequestHandler" ID="EricServerBaseRequestHandler"></a>
+<h2>EricServerBaseRequestHandler</h2>
+<p>
+    Class implementing the request handler base class of the eric-ide server.
+</p>
+
+<h3>Derived from</h3>
+None
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#EricServerBaseRequestHandler.__init__">EricServerBaseRequestHandler</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricServerBaseRequestHandler.handleRequest">handleRequest</a></td>
+<td>Public method handling the received file system requests.</td>
+</tr>
+<tr>
+<td><a href="#EricServerBaseRequestHandler.sendError">sendError</a></td>
+<td>Public method to send an error report to the IDE.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="EricServerBaseRequestHandler.__init__" ID="EricServerBaseRequestHandler.__init__"></a>
+<h4>EricServerBaseRequestHandler (Constructor)</h4>
+<b>EricServerBaseRequestHandler</b>(<i>server</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>server</i> (EricServer)</dt>
+<dd>
+reference to the eric-ide server object
+</dd>
+</dl>
+<a NAME="EricServerBaseRequestHandler.handleRequest" ID="EricServerBaseRequestHandler.handleRequest"></a>
+<h4>EricServerBaseRequestHandler.handleRequest</h4>
+<b>handleRequest</b>(<i>request, params, reqestUuid</i>)
+<p>
+        Public method handling the received file system requests.
+</p>
+
+<dl>
+
+<dt><i>request</i> (str)</dt>
+<dd>
+request name
+</dd>
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the request parameters
+</dd>
+<dt><i>reqestUuid</i> (str)</dt>
+<dd>
+UUID of the associated request as sent by the eric IDE
+</dd>
+</dl>
+<a NAME="EricServerBaseRequestHandler.sendError" ID="EricServerBaseRequestHandler.sendError"></a>
+<h4>EricServerBaseRequestHandler.sendError</h4>
+<b>sendError</b>(<i>request, reqestUuid=""</i>)
+<p>
+        Public method to send an error report to the IDE.
+</p>
+
+<dl>
+
+<dt><i>request</i> (str)</dt>
+<dd>
+request name
+</dd>
+<dt><i>reqestUuid</i> (str)</dt>
+<dd>
+UUID of the associated request as sent by the eric IDE
+            (defaults to "", i.e. no UUID received)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial