59 <table> |
59 <table> |
60 <tr> |
60 <tr> |
61 <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> |
61 <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> |
62 <td>Constructor of the BackgroundClient class.</td> |
62 <td>Constructor of the BackgroundClient class.</td> |
63 </tr><tr> |
63 </tr><tr> |
|
64 <td><a href="#BackgroundClient.__cancelled">__cancelled</a></td> |
|
65 <td>Private method to check for a job cancellation.</td> |
|
66 </tr><tr> |
64 <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> |
67 <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> |
65 <td>Private method to import the given module and register it as service.</td> |
68 <td>Private method to import the given module and register it as service.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#BackgroundClient.__peek">__peek</a></td> |
|
71 <td>Private methode to peek the given length of bytes.</td> |
66 </tr><tr> |
72 </tr><tr> |
67 <td><a href="#BackgroundClient.__receive">__receive</a></td> |
73 <td><a href="#BackgroundClient.__receive">__receive</a></td> |
68 <td>Private methode to receive the given length of bytes.</td> |
74 <td>Private methode to receive the given length of bytes.</td> |
69 </tr><tr> |
75 </tr><tr> |
70 <td><a href="#BackgroundClient.__send">__send</a></td> |
76 <td><a href="#BackgroundClient.__send">__send</a></td> |
89 ip address the background service is listening |
95 ip address the background service is listening |
90 </dd><dt><i>port</i></dt> |
96 </dd><dt><i>port</i></dt> |
91 <dd> |
97 <dd> |
92 port of the background service |
98 port of the background service |
93 </dd> |
99 </dd> |
|
100 </dl><a NAME="BackgroundClient.__cancelled" ID="BackgroundClient.__cancelled"></a> |
|
101 <h4>BackgroundClient.__cancelled</h4> |
|
102 <b>__cancelled</b>(<i></i>) |
|
103 <p> |
|
104 Private method to check for a job cancellation. |
|
105 </p><dl> |
|
106 <dt>Returns:</dt> |
|
107 <dd> |
|
108 flag indicating a cancellation (boolean) |
|
109 </dd> |
94 </dl><a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> |
110 </dl><a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> |
95 <h4>BackgroundClient.__initClientService</h4> |
111 <h4>BackgroundClient.__initClientService</h4> |
96 <b>__initClientService</b>(<i>fn, path, module</i>) |
112 <b>__initClientService</b>(<i>fn, path, module</i>) |
97 <p> |
113 <p> |
98 Private method to import the given module and register it as service. |
114 Private method to import the given module and register it as service. |
110 </dl><dl> |
126 </dl><dl> |
111 <dt>Returns:</dt> |
127 <dt>Returns:</dt> |
112 <dd> |
128 <dd> |
113 text result of the import action (str) |
129 text result of the import action (str) |
114 </dd> |
130 </dd> |
|
131 </dl><a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> |
|
132 <h4>BackgroundClient.__peek</h4> |
|
133 <b>__peek</b>(<i>length</i>) |
|
134 <p> |
|
135 Private methode to peek the given length of bytes. |
|
136 </p><dl> |
|
137 <dt><i>length</i></dt> |
|
138 <dd> |
|
139 bytes to receive (int) |
|
140 </dd> |
|
141 </dl><dl> |
|
142 <dt>Returns:</dt> |
|
143 <dd> |
|
144 received bytes (bytes) |
|
145 </dd> |
115 </dl><a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> |
146 </dl><a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> |
116 <h4>BackgroundClient.__receive</h4> |
147 <h4>BackgroundClient.__receive</h4> |
117 <b>__receive</b>(<i>length</i>) |
148 <b>__receive</b>(<i>length</i>) |
118 <p> |
149 <p> |
119 Private methode to receive the given length of bytes. |
150 Private methode to receive the given length of bytes. |
123 bytes to receive (int) |
154 bytes to receive (int) |
124 </dd> |
155 </dd> |
125 </dl><dl> |
156 </dl><dl> |
126 <dt>Returns:</dt> |
157 <dt>Returns:</dt> |
127 <dd> |
158 <dd> |
128 received bytes or None if connection closed (str) |
159 received bytes or None if connection closed (bytes) |
129 </dd> |
160 </dd> |
130 </dl><a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> |
161 </dl><a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> |
131 <h4>BackgroundClient.__send</h4> |
162 <h4>BackgroundClient.__send</h4> |
132 <b>__send</b>(<i>fx, fn, data</i>) |
163 <b>__send</b>(<i>fx, fn, data</i>) |
133 <p> |
164 <p> |