Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonClient.html
src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonClient.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 9209
- b99e7fd55fd3
- child 10523
- e4069ddd7dc7
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.EricNetwork.EricJsonClient</h1> | 9 <h1>eric7.EricNetwork.EricJsonClient</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the JSON based client base class. | 11 Module implementing the JSON based client base class. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#EricJsonClient">EricJsonClient</a></td> | 22 <td><a href="#EricJsonClient">EricJsonClient</a></td> |
| 25 <td>Class implementing a JSON based client base class.</td> | 23 <td>Class implementing a JSON based client base class.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="EricJsonClient" ID="EricJsonClient"></a> | 34 <a NAME="EricJsonClient" ID="EricJsonClient"></a> |
| 36 <h2>EricJsonClient</h2> | 35 <h2>EricJsonClient</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a JSON based client base class. | 37 Class implementing a JSON based client base class. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 None | 41 None |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | 43 <table> |
| 45 <table> | 44 <tr><td>None</td></tr> |
| 46 <tr><td>None</td></tr> | 45 </table> |
| 47 </table> | 46 |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#EricJsonClient.__init__">EricJsonClient</a></td> | 55 <td><a href="#EricJsonClient.__init__">EricJsonClient</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 77 <tr> | 74 <tr> |
| 78 <td><a href="#EricJsonClient.sendJson">sendJson</a></td> | 75 <td><a href="#EricJsonClient.sendJson">sendJson</a></td> |
| 79 <td>Public method to send a single refactoring command to the server.</td> | 76 <td>Public method to send a single refactoring command to the server.</td> |
| 80 </tr> | 77 </tr> |
| 81 </table> | 78 </table> |
| 79 | |
| 82 <h3>Static Methods</h3> | 80 <h3>Static Methods</h3> |
| 83 | 81 <table> |
| 84 <table> | 82 <tr><td>None</td></tr> |
| 85 <tr><td>None</td></tr> | 83 </table> |
| 86 </table> | 84 |
| 87 | 85 |
| 88 <a NAME="EricJsonClient.__init__" ID="EricJsonClient.__init__"></a> | 86 <a NAME="EricJsonClient.__init__" ID="EricJsonClient.__init__"></a> |
| 89 <h4>EricJsonClient (Constructor)</h4> | 87 <h4>EricJsonClient (Constructor)</h4> |
| 90 <b>EricJsonClient</b>(<i>host, port, idString=""</i>) | 88 <b>EricJsonClient</b>(<i>host, port, idString=""</i>) |
| 91 | |
| 92 <p> | 89 <p> |
| 93 Constructor | 90 Constructor |
| 94 </p> | 91 </p> |
| 92 | |
| 95 <dl> | 93 <dl> |
| 96 | 94 |
| 97 <dt><i>host</i> (str)</dt> | 95 <dt><i>host</i> (str)</dt> |
| 98 <dd> | 96 <dd> |
| 99 IP address the background service is listening | 97 IP address the background service is listening |
| 109 </dd> | 107 </dd> |
| 110 </dl> | 108 </dl> |
| 111 <a NAME="EricJsonClient.__receiveJson" ID="EricJsonClient.__receiveJson"></a> | 109 <a NAME="EricJsonClient.__receiveJson" ID="EricJsonClient.__receiveJson"></a> |
| 112 <h4>EricJsonClient.__receiveJson</h4> | 110 <h4>EricJsonClient.__receiveJson</h4> |
| 113 <b>__receiveJson</b>(<i></i>) | 111 <b>__receiveJson</b>(<i></i>) |
| 114 | |
| 115 <p> | 112 <p> |
| 116 Private method to receive a JSON encode command and data from the | 113 Private method to receive a JSON encode command and data from the |
| 117 server. | 114 server. |
| 118 </p> | 115 </p> |
| 116 | |
| 119 <dl> | 117 <dl> |
| 120 <dt>Return:</dt> | 118 <dt>Return:</dt> |
| 121 <dd> | 119 <dd> |
| 122 tuple containing the received command and a dictionary | 120 tuple containing the received command and a dictionary |
| 123 containing the associated data | 121 containing the associated data |
| 130 </dd> | 128 </dd> |
| 131 </dl> | 129 </dl> |
| 132 <a NAME="EricJsonClient.handleCall" ID="EricJsonClient.handleCall"></a> | 130 <a NAME="EricJsonClient.handleCall" ID="EricJsonClient.handleCall"></a> |
| 133 <h4>EricJsonClient.handleCall</h4> | 131 <h4>EricJsonClient.handleCall</h4> |
| 134 <b>handleCall</b>(<i>method, params</i>) | 132 <b>handleCall</b>(<i>method, params</i>) |
| 135 | |
| 136 <p> | 133 <p> |
| 137 Public method to handle a method call from the server. | 134 Public method to handle a method call from the server. |
| 138 </p> | 135 </p> |
| 139 <p> | 136 <p> |
| 140 Note: This is an empty implementation that must be overridden in | 137 Note: This is an empty implementation that must be overridden in |
| 141 derived classes. | 138 derived classes. |
| 142 </p> | 139 </p> |
| 140 | |
| 143 <dl> | 141 <dl> |
| 144 | 142 |
| 145 <dt><i>method</i> (str)</dt> | 143 <dt><i>method</i> (str)</dt> |
| 146 <dd> | 144 <dd> |
| 147 requested method name | 145 requested method name |
| 152 </dd> | 150 </dd> |
| 153 </dl> | 151 </dl> |
| 154 <a NAME="EricJsonClient.poll" ID="EricJsonClient.poll"></a> | 152 <a NAME="EricJsonClient.poll" ID="EricJsonClient.poll"></a> |
| 155 <h4>EricJsonClient.poll</h4> | 153 <h4>EricJsonClient.poll</h4> |
| 156 <b>poll</b>(<i>waitMethod=""</i>) | 154 <b>poll</b>(<i>waitMethod=""</i>) |
| 157 | |
| 158 <p> | 155 <p> |
| 159 Public method to check and receive one message (if available). | 156 Public method to check and receive one message (if available). |
| 160 </p> | 157 </p> |
| 158 | |
| 161 <dl> | 159 <dl> |
| 162 | 160 |
| 163 <dt><i>waitMethod</i> (str)</dt> | 161 <dt><i>waitMethod</i> (str)</dt> |
| 164 <dd> | 162 <dd> |
| 165 name of a method to wait for | 163 name of a method to wait for |
| 178 </dd> | 176 </dd> |
| 179 </dl> | 177 </dl> |
| 180 <a NAME="EricJsonClient.run" ID="EricJsonClient.run"></a> | 178 <a NAME="EricJsonClient.run" ID="EricJsonClient.run"></a> |
| 181 <h4>EricJsonClient.run</h4> | 179 <h4>EricJsonClient.run</h4> |
| 182 <b>run</b>(<i></i>) | 180 <b>run</b>(<i></i>) |
| 183 | |
| 184 <p> | 181 <p> |
| 185 Public method implementing the main loop of the client. | 182 Public method implementing the main loop of the client. |
| 186 </p> | 183 </p> |
| 184 | |
| 187 <a NAME="EricJsonClient.sendJson" ID="EricJsonClient.sendJson"></a> | 185 <a NAME="EricJsonClient.sendJson" ID="EricJsonClient.sendJson"></a> |
| 188 <h4>EricJsonClient.sendJson</h4> | 186 <h4>EricJsonClient.sendJson</h4> |
| 189 <b>sendJson</b>(<i>command, params</i>) | 187 <b>sendJson</b>(<i>command, params</i>) |
| 190 | |
| 191 <p> | 188 <p> |
| 192 Public method to send a single refactoring command to the server. | 189 Public method to send a single refactoring command to the server. |
| 193 </p> | 190 </p> |
| 191 | |
| 194 <dl> | 192 <dl> |
| 195 | 193 |
| 196 <dt><i>command</i> (str)</dt> | 194 <dt><i>command</i> (str)</dt> |
| 197 <dd> | 195 <dd> |
| 198 command name to be sent | 196 command name to be sent |
