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

Fri, 14 Jun 2024 11:23:45 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 14 Jun 2024 11:23:45 +0200
branch
eric7
changeset 10784
521fd465b048
permissions
-rw-r--r--

Added source documentation for the eric-ide server.

10784
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.RemoteServer.EricServerBaseRequestHandler</title>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.RemoteServer.EricServerBaseRequestHandler</h1>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 Module implementing the request handler base class of the eric-ide server.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <td><a href="#EricServerBaseRequestHandler">EricServerBaseRequestHandler</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <td>Class implementing the request handler base class of the eric-ide server.</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Functions</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <a NAME="EricServerBaseRequestHandler" ID="EricServerBaseRequestHandler"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <h2>EricServerBaseRequestHandler</h2>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 Class implementing the request handler base class of the eric-ide server.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <h3>Derived from</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 None
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Class Attributes</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Class Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <h3>Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <td><a href="#EricServerBaseRequestHandler.__init__">EricServerBaseRequestHandler</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <td>Constructor</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td><a href="#EricServerBaseRequestHandler.handleRequest">handleRequest</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td>Public method handling the received file system requests.</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#EricServerBaseRequestHandler.sendError">sendError</a></td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Public method to send an error report to the IDE.</td>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <h3>Static Methods</h3>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <tr><td>None</td></tr>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </table>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <a NAME="EricServerBaseRequestHandler.__init__" ID="EricServerBaseRequestHandler.__init__"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <h4>EricServerBaseRequestHandler (Constructor)</h4>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <b>EricServerBaseRequestHandler</b>(<i>server</i>)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 Constructor
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dt><i>server</i> (EricServer)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 reference to the eric-ide server object
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <a NAME="EricServerBaseRequestHandler.handleRequest" ID="EricServerBaseRequestHandler.handleRequest"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <h4>EricServerBaseRequestHandler.handleRequest</h4>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <b>handleRequest</b>(<i>request, params, reqestUuid</i>)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 Public method handling the received file system requests.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <dt><i>request</i> (str)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 request name
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <dt><i>params</i> (dict)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 dictionary containing the request parameters
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <dt><i>reqestUuid</i> (str)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 UUID of the associated request as sent by the eric IDE
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <a NAME="EricServerBaseRequestHandler.sendError" ID="EricServerBaseRequestHandler.sendError"></a>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <h4>EricServerBaseRequestHandler.sendError</h4>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <b>sendError</b>(<i>request, reqestUuid=""</i>)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 Public method to send an error report to the IDE.
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </p>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 <dt><i>request</i> (str)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 request name
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <dt><i>reqestUuid</i> (str)</dt>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 <dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 UUID of the associated request as sent by the eric IDE
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 (defaults to "", i.e. no UUID received)
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 </dd>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </dl>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 <div align="right"><a href="#top">Up</a></div>
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <hr />
521fd465b048 Added source documentation for the eric-ide server.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </body></html>

eric ide

mercurial