diff options
author | Gabor X Toth <*@tg-x.net> | 2016-02-21 14:09:16 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2016-02-21 14:09:16 +0000 |
commit | 5a9d5f705ed5ea9371bcb7c96004098a3853f46f (patch) | |
tree | 80184f5388d24e3dba3efad0fcad9eb4cf8c15df /src/include/gnunet_social_service.h | |
parent | 1f2325002d2d0bfa1f91710346376ac00a1d28ae (diff) | |
download | gnunet-5a9d5f705ed5ea9371bcb7c96004098a3853f46f.tar.gz gnunet-5a9d5f705ed5ea9371bcb7c96004098a3853f46f.zip |
social: AppPlaceState doc
Diffstat (limited to 'src/include/gnunet_social_service.h')
-rw-r--r-- | src/include/gnunet_social_service.h | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/src/include/gnunet_social_service.h b/src/include/gnunet_social_service.h index 7ecdf1d53..88ebc3dad 100644 --- a/src/include/gnunet_social_service.h +++ b/src/include/gnunet_social_service.h | |||
@@ -307,24 +307,27 @@ typedef void | |||
307 | 307 | ||
308 | 308 | ||
309 | /** | 309 | /** |
310 | * Entry status of a place. | 310 | * Entry status of a place per application. |
311 | * | ||
312 | * Note: The intermediate status of having entered a place without | ||
313 | * being subscribed to it may be obsoleted in future unless we find a | ||
314 | * compelling reason for it to exist. FIXME: See questions.org. | ||
315 | */ | 311 | */ |
316 | enum GNUNET_SOCIAL_PlaceState | 312 | enum GNUNET_SOCIAL_AppPlaceState |
317 | { | 313 | { |
318 | /** | 314 | /** |
319 | * Place was once entered but left since. | 315 | * The place was once entered by the ego, but left since. |
316 | * It's possible to establish a local connection to the place | ||
317 | * without re-entering to fetch history from the PSYCstore. | ||
318 | * @see enum GNUNET_PSYC_SlaveJoinFlags and GNUNET_SOCIAL_guest_enter() | ||
320 | */ | 319 | */ |
321 | GNUNET_SOCIAL_PLACE_STATE_ARCHIVED = 0, | 320 | GNUNET_SOCIAL_PLACE_STATE_ARCHIVED = 0, |
321 | |||
322 | /** | 322 | /** |
323 | * Place is entered but not subscribed. | 323 | * The place is entered by the ego, |
324 | * but this application is not subscribed to it. | ||
324 | */ | 325 | */ |
325 | GNUNET_SOCIAL_PLACE_STATE_ENTERED = 1, | 326 | GNUNET_SOCIAL_PLACE_STATE_ENTERED = 1, |
327 | |||
326 | /** | 328 | /** |
327 | * Place is entered and subscribed. | 329 | * The place is entered by the ego and |
330 | * and this application is subscribed to it. | ||
328 | */ | 331 | */ |
329 | GNUNET_SOCIAL_PLACE_STATE_SUBSCRIBED = 2, | 332 | GNUNET_SOCIAL_PLACE_STATE_SUBSCRIBED = 2, |
330 | }; | 333 | }; |
@@ -342,14 +345,14 @@ enum GNUNET_SOCIAL_PlaceState | |||
342 | * @param place_pub_key | 345 | * @param place_pub_key |
343 | * Public key of the place. | 346 | * Public key of the place. |
344 | * @param place_state | 347 | * @param place_state |
345 | * @see enum GNUNET_SOCIAL_PlaceState | 348 | * @see enum GNUNET_SOCIAL_AppPlaceState |
346 | */ | 349 | */ |
347 | typedef void | 350 | typedef void |
348 | (*GNUNET_SOCIAL_AppHostPlaceCallback) (void *cls, | 351 | (*GNUNET_SOCIAL_AppHostPlaceCallback) (void *cls, |
349 | struct GNUNET_SOCIAL_HostConnection *hconn, | 352 | struct GNUNET_SOCIAL_HostConnection *hconn, |
350 | struct GNUNET_SOCIAL_Ego *ego, | 353 | struct GNUNET_SOCIAL_Ego *ego, |
351 | const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key, | 354 | const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key, |
352 | enum GNUNET_SOCIAL_PlaceState place_state); | 355 | enum GNUNET_SOCIAL_AppPlaceState place_state); |
353 | 356 | ||
354 | /** | 357 | /** |
355 | * Notification about a place. | 358 | * Notification about a place. |
@@ -363,14 +366,14 @@ typedef void | |||
363 | * @param place_pub_key | 366 | * @param place_pub_key |
364 | * Public key of the place. | 367 | * Public key of the place. |
365 | * @param place_state | 368 | * @param place_state |
366 | * @see enum GNUNET_SOCIAL_PlaceState | 369 | * @see enum GNUNET_SOCIAL_AppPlaceState |
367 | */ | 370 | */ |
368 | typedef void | 371 | typedef void |
369 | (*GNUNET_SOCIAL_AppGuestPlaceCallback) (void *cls, | 372 | (*GNUNET_SOCIAL_AppGuestPlaceCallback) (void *cls, |
370 | struct GNUNET_SOCIAL_GuestConnection *gconn, | 373 | struct GNUNET_SOCIAL_GuestConnection *gconn, |
371 | struct GNUNET_SOCIAL_Ego *ego, | 374 | struct GNUNET_SOCIAL_Ego *ego, |
372 | const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key, | 375 | const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key, |
373 | enum GNUNET_SOCIAL_PlaceState place_state); | 376 | enum GNUNET_SOCIAL_AppPlaceState place_state); |
374 | 377 | ||
375 | 378 | ||
376 | /** | 379 | /** |