From: Gabor X Toth <*@tg-x.net>
Date: Sun, 21 Feb 2016 14:09:16 +0000 (+0000)
Subject: social: AppPlaceState doc
X-Git-Tag: initial-import-from-subversion-38251~1027
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=5a9d5f705ed5ea9371bcb7c96004098a3853f46f;p=oweals%2Fgnunet.git

social: AppPlaceState doc
---

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
 
 
 /**
- * Entry status of a place.
- *
- * Note: The intermediate status of having entered a place without
- * being subscribed to it may be obsoleted in future unless we find a
- * compelling reason for it to exist. FIXME: See questions.org.
+ * Entry status of a place per application.
  */
-enum GNUNET_SOCIAL_PlaceState
+enum GNUNET_SOCIAL_AppPlaceState
 {
   /**
-   * Place was once entered but left since.
+   * The place was once entered by the ego, but left since.
+   * It's possible to establish a local connection to the place
+   * without re-entering to fetch history from the PSYCstore.
+   * @see enum GNUNET_PSYC_SlaveJoinFlags and GNUNET_SOCIAL_guest_enter()
    */
   GNUNET_SOCIAL_PLACE_STATE_ARCHIVED = 0,
+
   /**
-   * Place is entered but not subscribed.
+   * The place is entered by the ego,
+   * but this application is not subscribed to it.
    */
   GNUNET_SOCIAL_PLACE_STATE_ENTERED = 1,
+
   /**
-   * Place is entered and subscribed.
+   * The place is entered by the ego and
+   * and this application is subscribed to it.
    */
   GNUNET_SOCIAL_PLACE_STATE_SUBSCRIBED = 2,
 };
@@ -342,14 +345,14 @@ enum GNUNET_SOCIAL_PlaceState
  * @param place_pub_key
  *        Public key of the place.
  * @param place_state
- *        @see enum GNUNET_SOCIAL_PlaceState
+ *        @see enum GNUNET_SOCIAL_AppPlaceState
  */
 typedef void
 (*GNUNET_SOCIAL_AppHostPlaceCallback) (void *cls,
                                        struct GNUNET_SOCIAL_HostConnection *hconn,
                                        struct GNUNET_SOCIAL_Ego *ego,
                                        const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
-                                       enum GNUNET_SOCIAL_PlaceState place_state);
+                                       enum GNUNET_SOCIAL_AppPlaceState place_state);
 
 /**
  * Notification about a place.
@@ -363,14 +366,14 @@ typedef void
  * @param place_pub_key
  *        Public key of the place.
  * @param place_state
- *        @see enum GNUNET_SOCIAL_PlaceState
+ *        @see enum GNUNET_SOCIAL_AppPlaceState
  */
 typedef void
 (*GNUNET_SOCIAL_AppGuestPlaceCallback) (void *cls,
                                         struct GNUNET_SOCIAL_GuestConnection *gconn,
                                         struct GNUNET_SOCIAL_Ego *ego,
                                         const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
-                                        enum GNUNET_SOCIAL_PlaceState place_state);
+                                        enum GNUNET_SOCIAL_AppPlaceState place_state);
 
 
 /**
diff --git a/src/social/social_api.c b/src/social/social_api.c
index 63ff677a4..edda0203e 100644
--- a/src/social/social_api.c
+++ b/src/social/social_api.c
@@ -103,12 +103,6 @@ struct GNUNET_SOCIAL_App
   GNUNET_SOCIAL_AppHostPlaceCallback host_cb;
   GNUNET_SOCIAL_AppGuestPlaceCallback guest_cb;
   void *cb_cls;
-
-  /**
-   * Is this place in the process of disconnecting from the service?
-   * #GNUNET_YES or #GNUNET_NO
-   */
-  uint8_t is_disconnecting;
 };
 
 
@@ -182,12 +176,6 @@ struct GNUNET_SOCIAL_Place
    * Does this place belong to a host (#GNUNET_YES) or guest (#GNUNET_NO)?
    */
   uint8_t is_host;
-
-  /**
-   * Is this place in the process of disconnecting from the service?
-   * #GNUNET_YES or #GNUNET_NO
-   */
-  uint8_t is_disconnecting;
 };
 
 
@@ -1509,7 +1497,6 @@ place_disconnect (struct GNUNET_SOCIAL_Place *plc,
                   GNUNET_ContinuationCallback disconnect_cb,
                   void *disconnect_cls)
 {
-  plc->is_disconnecting = GNUNET_YES;
   plc->disconnect_cb = disconnect_cb;
   plc->disconnect_cls = disconnect_cls;