264 | | repeat_sec:: |
265 | | A time interval after which another RPC should be done. |
266 | | signing_key:: |
267 | | The public key used to sign URLs, in an encoded notation. |
268 | | Use the BOINC crypt_prog program to generate this. |
269 | | message:: |
270 | | A message to be displayed to the user. |
271 | | global_preferences:: |
272 | | New global preferences. Included only if these are newer than those in the request message. |
273 | | opaque:: |
274 | | Arbitrary XML. Will be included in the next request message from the client. |
275 | | Use this e.g. to store a host ID. |
276 | | rss_feeds:: |
277 | | A list of RSS feeds to be displayed as Notices by the BOINC Manager. |
278 | | Typically this is a feed of news items from the account manager. |
279 | | |
280 | | For each account, the following items are returned: |
281 | | |
282 | | url:: |
283 | | The project URL |
284 | | url_signature:: |
285 | | A signature for the URL. Use the BOINC crypt_prog program to generate this. |
286 | | authenticator:: |
287 | | The account's authenticator. |
288 | | detach:: |
289 | | If nonzero, the client should detach this project. |
290 | | update:: |
291 | | If nonzero, the client should contact this project to get new global preferences. |
292 | | dont_request_more_work:: |
293 | | If nonzero, don't request any more work from this project. |
294 | | detach_when_done:: |
295 | | If nonzero, detach from this project when all work is completed |
296 | | resource_share:: |
297 | | Specifies a resource share for this project. |
298 | | If present, this overrides the resource share reported by the project. |
299 | | Thus, account managers can provide per-host control of resource share. |
| 270 | * '''repeat_sec''': |
| 271 | A time interval after which another RPC should be done. |
| 272 | * '''signing_key''': |
| 273 | The public key used to sign URLs, in an encoded notation. |
| 274 | Use the BOINC crypt_prog program to generate this. |
| 275 | * '''message''': |
| 276 | A message to be displayed to the user. |
| 277 | * '''global_preferences''': |
| 278 | New global preferences. Included only if these are newer than those in the request message. |
| 279 | * '''opaque''': |
| 280 | Arbitrary XML. Will be included in the next request message from the client. |
| 281 | Use this e.g. to store a host ID. |
| 282 | * '''rss_feeds''': |
| 283 | A list of RSS feeds to be displayed as Notices by the BOINC Manager. |
| 284 | Typically this is a feed of news items from the account manager. |
| 285 | * '''account''': |
| 286 | An account to which the client should attach. |
| 287 | For each account, the following items are returned: |
| 288 | * '''url''': |
| 289 | The project URL |
| 290 | * '''url_signature''': |
| 291 | A signature for the URL. Use the BOINC crypt_prog program to generate this. |
| 292 | * '''authenticator''': |
| 293 | The account's authenticator. |
| 294 | * '''detach''': |
| 295 | If nonzero, the client should detach this project. |
| 296 | * '''update''': |
| 297 | If nonzero, the client should contact this project to get new global preferences. |
| 298 | * '''dont_request_more_work''': |
| 299 | If nonzero, don't request any more work from this project. |
| 300 | * '''detach_when_done''': |
| 301 | If nonzero, detach from this project when all work is completed |
| 302 | * '''resource_share''': |
| 303 | Specifies a resource share for this project. |
| 304 | If present, this overrides the resource share reported by the project. |
| 305 | Thus, account managers can provide per-host control of resource share. |
308 | | * Cross-project ID (CPID). |
309 | | This is used in the statistics data exported by projects. |
310 | | The 'authoritative' CPID is stored on the host itself. |
311 | | A host's CPID changes whenever it attaches to a new project. |
312 | | CPID is propagated to projects in scheduler RPCs. |
313 | | If a host is attached to several projects, its CPID (as reported by those projects) |
314 | | may be inconsistent for several days. |
315 | | Because of these properties, CPID is not useful as a primary host identifier. |
316 | | * Project database ID (DBID). |
317 | | This is a project-specific integer identifier. |
318 | | On a given host, it changes only in the rare case |
319 | | where a user copies state files from one computer to another; |
320 | | in that case, one of the two computers is assigned a new ID after its next scheduler RPC. |
| 314 | * Cross-project ID (CPID). |
| 315 | This is used in the statistics data exported by projects. |
| 316 | The 'authoritative' CPID is stored on the host itself. |
| 317 | A host's CPID changes whenever it attaches to a new project. |
| 318 | CPID is propagated to projects in scheduler RPCs. |
| 319 | If a host is attached to several projects, its CPID (as reported by those projects) |
| 320 | may be inconsistent for several days. |
| 321 | Because of these properties, CPID is not useful as a primary host identifier. |
| 322 | * Project database ID (DBID). |
| 323 | This is a project-specific integer identifier. |
| 324 | On a given host, it changes only in the rare case |
| 325 | where a user copies state files from one computer to another; |
| 326 | in that case, one of the two computers is assigned a new ID after its next scheduler RPC. |