Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @file include/gnunet_social_service.h
* @brief Social service; implements social functionality using the PSYC service.
- * @author tg
+ * @author Gabor X Toth
* @author Christian Grothoff
*/
#ifndef GNUNET_SOCIAL_SERVICE_H
#endif
#include "gnunet_util_lib.h"
+#include "gnunet_psyc_lib.h"
#include "gnunet_psyc_service.h"
#include "gnunet_multicast_service.h"
-/**
+/**
* Version number of GNUnet Social API.
*/
#define GNUNET_SOCIAL_VERSION 0x00000000
-/**
- * Handle for our own presence in the network (we can of course have
- * alter-egos).
- */
-struct GNUNET_SOCIAL_Ego;
-/**
+/**
* Handle for another user (who is likely pseudonymous) in the network.
*/
struct GNUNET_SOCIAL_Nym;
-/**
+/**
* Handle for a place where social interactions happen.
*/
struct GNUNET_SOCIAL_Place;
-/**
+/**
* Handle for a place that one of our egos hosts.
*/
struct GNUNET_SOCIAL_Home;
-/**
+/**
* Handle to an implementation of try-and-slice.
*/
struct GNUNET_SOCIAL_Slicer;
-/**
+/**
* Method called from SOCIAL upon receiving a message indicating a call
- * to a 'method'.
+ * to a @e method.
*
* @param cls Closure.
+ * @param nym The sender of the message. NULL for the ego's own messages to the home.
* @param full_method_name Original method name from PSYC (may be more
* specific than the registered method name due to try-and-slice matching).
* @param message_id Unique message counter for this message
* (unique only in combination with the given sender for
* this channel).
- * @param data_off Byte offset of 'data' in the overall data of the method.
- * @param data_size Number of bytes in 'data'.
- * @param data data stream given to the method (might not be zero-terminated
- * if data is binary)
- * @param frag fragmentation status for the data
- */
-typedef int (*GNUNET_SOCIAL_Method)(void *cls,
- const char *full_method_name,
- uint64_t message_id,
- uint64_t data_off,
- size_t data_size,
- const void *data,
- enum GNUNET_PSYC_FragmentStatus frag);
-
-
-/**
+ * @param modifier_count Number of elements in the @a modifiers array.
+ * @param modifiers Modifiers present in the message. FIXME: use environment instead?
+ * @param data_offset Byte offset of @a data in the overall data of the method.
+ * @param data Data stream given to the method (might not be zero-terminated
+ * if data is binary).
+ * @param data_size Number of bytes in @a data.
+ * @param flags Message flags indicating fragmentation status.
+ */
+typedef int
+(*GNUNET_SOCIAL_Method) (void *cls,
+ struct GNUNET_SOCIAL_Nym *nym,
+ const char *full_method_name,
+ uint64_t message_id,
+ size_t modifier_count,
+ GNUNET_PSYC_Modifier *modifiers,
+ uint64_t data_offset,
+ const void *data,
+ size_t data_size,
+ enum GNUNET_PSYC_MessageFlags flags);
+
+
+/**
* Create a try-and-slice instance.
*
* @return A new try-and-slice construct.
GNUNET_SOCIAL_slicer_create (void);
-/**
+/**
* Add a method to the try-and-slice instance.
*
* A slicer processes messages and calls methods that match a message. A match
*/
void
GNUNET_SOCIAL_slicer_add (struct GNUNET_SOCIAL_Slicer *slicer,
- const char *method_name,
- GNUNET_SOCIAL_Method method,
- void *method_cls);
+ const char *method_name,
+ GNUNET_SOCIAL_Method method,
+ void *method_cls);
-/* FIXME: No slicer_remove for now, is it needed? */
-/**
- * Destroy a given try-and-slice instance.
+/**
+ * Remove a registered method from the try-and-slice instance.
*
- * @param slicer slicer to destroy
+ * @param slicer The try-and-slice instance.
+ * @param method_name Name of the method to remove.
+ * @param method Method handler.
*/
void
-GNUNET_SOCIAL_slicer_destroy (struct GNUNET_SOCIAL_Slicer *slicer);
-
-
-/**
- * Create an ego.
- *
- * Create an ego using the private key from the given file. If the file does
- * not exist, a fresh key is created.
- *
- * @param keyfile name of the file with the private key for the ego,
- * NULL for ephemeral egos
- * @return handle to the ego, NULL on error
- */
-struct GNUNET_SOCIAL_Ego *
-GNUNET_SOCIAL_ego_create (const char *keyfile);
+GNUNET_SOCIAL_slicer_remove (struct GNUNET_SOCIAL_Slicer *slicer,
+ const char *method_name,
+ GNUNET_SOCIAL_Method method);
-
-/**
- * Destroy a handle to an ego.
+/**
+ * Destroy a given try-and-slice instance.
*
- * @param ego ego to destroy
+ * @param slicer slicer to destroy
*/
void
-GNUNET_SOCIAL_ego_destroy (struct GNUNET_SOCIAL_Ego *ego);
+GNUNET_SOCIAL_slicer_destroy (struct GNUNET_SOCIAL_Slicer *slicer);
-/**
+/**
* Function called asking for nym to be admitted to the place.
*
- * Should call either 'GNUNET_SOCIAL_home_admit' or
- * 'GNUNET_SOCIAL_home_reject_entry' (possibly asynchronously). If this owner
+ * Should call either GNUNET_SOCIAL_home_admit() or
+ * GNUNET_SOCIAL_home_reject_entry() (possibly asynchronously). If this owner
* cannot decide, it is fine to call neither function, in which case hopefully
- * some other owner of the home exists that will make the decision. The 'nym'
- * reference remains valid until the 'GNUNET_SOCIAL_FarewellCallback' is invoked
+ * some other owner of the home exists that will make the decision. The @a nym
+ * reference remains valid until the #GNUNET_SOCIAL_FarewellCallback is invoked
* for it.
*
* @param cls Closure.
- * @param nym Handle for the user who wants to join.
- * @param join_msg_size Number of bytes in 'join_msg'.
- * @param join_msg Payload given on join (e.g. a password).
+ * @param nym Handle for the user who wants to enter.
+ * @param method_name Method name in the entry request.
+ * @param variable_count Number of elements in the @a variables array.
+ * @param variables Variables present in the message.
+ * @param data Payload given on enter (e.g. a password).
+ * @param data_size Number of bytes in @a data.
*/
-typedef void (*GNUNET_SOCIAL_AnswerDoorCallback)(void *cls,
- struct GNUNET_SOCIAL_Nym *nym,
- size_t join_msg_size,
- const void *join_msg);
+typedef void
+(*GNUNET_SOCIAL_AnswerDoorCallback) (void *cls,
+ struct GNUNET_SOCIAL_Nym *nym,
+ size_t variable_count,
+ const char *method_name,
+ GNUNET_PSYC_Modifier *variables,
+ const void *data,
+ size_t data_size);
-/**
- * Function called when a 'nym' leaves the place.
- *
- * This is also called if the 'nym' was never given permission to enter
- * (i.e. the 'nym' stopped asking to get in).
+/**
+ * Function called when a @a nym leaves the place.
+ *
+ * This is also called if the @a nym was never given permission to enter
+ * (i.e. the @a nym stopped asking to get in).
*
* @param cls Closure.
* @param nym Handle for the user who left.
+ * @param variable_count Number of elements in the @a variables array.
+ * @param variables Variables present in the message.
*/
-typedef void (*GNUNET_SOCIAL_FarewellCallback)(void *cls,
- struct GNUNET_SOCIAL_Nym *nym);
+typedef void
+(*GNUNET_SOCIAL_FarewellCallback) (void *cls,
+ struct GNUNET_SOCIAL_Nym *nym,
+ size_t variable_count,
+ GNUNET_PSYC_Modifier *variables);
-/**
+/**
* Enter a home where guests (nyms) can be hosted.
*
* A home is created upon first entering, and exists until
- * 'GNUNET_SOCIAL_home_destroy' is called. It can also be left temporarily using
- * 'GNUNET_SOCIAL_home_leave'.
+ * GNUNET_SOCIAL_home_destroy() is called. It can also be left temporarily using
+ * GNUNET_SOCIAL_home_leave().
*
* @param cfg Configuration to contact the social service.
- * @param home_keyfile File with the private key for the home,
- * created if the file does not exist;
- * pass NULL for ephemeral homes.
- * @param join_policy What is our policy for allowing people in?
+ * @param home_keyfile File with the private-public key pair of the home,
+ * created if the file does not exist; pass NULL for ephemeral homes.
+ * @param policy Policy specifying entry and history restrictions of the home.
* @param ego Owner of the home (host).
* @param slicer Slicer to handle guests talking.
- * @param listener_cb Function to handle new nyms that want to join.
+ * @param listener_cb Function to handle new nyms that want to enter.
* @param farewell_cb Function to handle departing nyms.
- * @param cls Closure for 'listener_cb' and 'farewell_cb'.
+ * @param cls Closure for @a listener_cb and @a farewell_cb.
* @return Handle for a new home.
*/
struct GNUNET_SOCIAL_Home *
GNUNET_SOCIAL_home_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *home_keyfile,
- enum GNUNET_MULTICAST_JoinPolicy join_policy,
- struct GNUNET_SOCIAL_Ego *ego,
- struct GNUNET_SOCIAL_Slicer *slicer,
- GNUNET_SOCIAL_AnswerDoorCallback listener_cb,
- GNUNET_SOCIAL_FarewellCallback farewell_cb,
- void *cls);
+ const char *home_keyfile,
+ enum GNUNET_PSYC_Policy policy,
+ struct GNUNET_IDENTITY_Ego *ego,
+ struct GNUNET_SOCIAL_Slicer *slicer,
+ GNUNET_SOCIAL_AnswerDoorCallback listener_cb,
+ GNUNET_SOCIAL_FarewellCallback farewell_cb,
+ void *cls);
-/**
- * Admit 'nym' to the 'home'.
+/**
+ * Admit @a nym to the @a home.
*
- * The 'nym' reference will remain valid until either the home is destroyed or
- * 'nym' leaves.
+ * The @a nym reference will remain valid until either the home is destroyed or
+ * @a nym leaves.
*
- * @param home Home to allow 'nym' to join.
- * @param nym Handle for the entity that wants to join.
+ * @param home Home to allow @a nym to enter.
+ * @param nym Handle for the entity that wants to enter.
*/
void
GNUNET_SOCIAL_home_admit (struct GNUNET_SOCIAL_Home *home,
- struct GNUNET_SOCIAL_Nym *nym);
+ struct GNUNET_SOCIAL_Nym *nym);
-/**
- * Throw 'nym' out of the 'home'.
+/**
+ * Throw @a nym out of the @a home.
*
- * The 'nym' reference will remain valid until the
- * 'GNUNET_SOCIAL_FarewellCallback' is invoked,
+ * The @a nym reference will remain valid until the
+ * #GNUNET_SOCIAL_FarewellCallback is invoked,
* which should be very soon after this call.
*
- * @param home Home to eject nym from.
+ * @param home Home to eject @a nym from.
* @param nym Handle for the entity to be ejected.
*/
void
struct GNUNET_SOCIAL_Nym *nym);
-/**
- * Refuse 'nym' entry into the 'home'.
+/**
+ * Refuse @a nym entry into the @a home.
*
- * @param home Home to disallow 'nym' to join.
- * @param nym Handle for the entity that wanted to join.
- * @param method Method name to invoke on caller.
- * @param message_size Number of bytes in 'message' for method.
- * @param message Rejection message to send back.
- *
- * FIXME: allow setting variables as well for the message
+ * @param home Home to disallow @a nym to enter.
+ * @param nym Handle for the entity that wanted to enter.
+ * @param method_name Method name for the rejection message.
+ * @param env Environment containing variables for the message, or NULL.
+ * @param data Data for the rejection message to send back.
+ * @param data_size Number of bytes in @a data for method.
*/
void
GNUNET_SOCIAL_home_reject_entry (struct GNUNET_SOCIAL_Home *home,
- struct GNUNET_SOCIAL_Nym *nym,
- const char *method,
- size_t message_size,
- const void *message);
+ struct GNUNET_SOCIAL_Nym *nym,
+ const char *method_name,
+ const struct GNUNET_ENV_Environment *env,
+ const void *data,
+ size_t data_size);
-/**
- * Get the identity of a user.
+/**
+ * Get the public key of a nym.
*
- * Suitable, for example, to be used with 'GNUNET_NAMESTORE_zone_to_name'.
+ * Suitable, for example, to be used with GNUNET_NAMESTORE_zone_to_name().
*
* @param nym Pseudonym to map to a cryptographic identifier.
- * @param identity Set to the identity of the nym (short hash of the public key).
+ * @param[out] nym_key Set to the public key of the nym.
*/
void
-GNUNET_SOCIAL_nym_get_identity (struct GNUNET_SOCIAL_Nym *nym,
- struct GNUNET_CRYPTO_ShortHashCode *identity);
+GNUNET_SOCIAL_nym_get_key (struct GNUNET_SOCIAL_Nym *nym,
+ struct GNUNET_CRYPTO_EddsaPublicKey *nym_key);
-/**
- * Obtain the (cryptographic, binary) address for the home.
- *
- * @param home Home to get the (public) address from.
- * @param crypto_address Address suitable for storing in GADS, i.e. in
- * 'HEX.place' or within the respective GADS record type ("PLACE")
+/**
+ * Obtain the private-public key pair of the home.
+ *
+ * @param home Home to get the key of.
+ * @param[out] home_key Set to the private-public key pair of the home. The public part is suitable for storing in GNS within a "PLACE" record, along with peer IDs to join at.
*/
void
-GNUNET_SOCIAL_home_get_address (struct GNUNET_SOCIAL_Home *home,
- struct GNUNET_HashCode *crypto_address);
+GNUNET_SOCIAL_home_get_key (struct GNUNET_SOCIAL_Home *home,
+ struct GNUNET_CRYPTO_EddsaPrivateKey *home_key);
-/**
- * (Re)decorate the home by changing objects in it.
+/**
+ * Advertise @a home under @a name in the GNS zone of the @e ego.
*
- * If the operation is 'GNUNET_PSYC_SOT_SET_VARIABLE' then the decoration only
- * applies to the next announcement by the home owner.
- *
- * @param home The home to decorate.
- * @param operation Operation to perform on the object.
- * @param object_name Name of the object to modify.
- * @param object_value_size Size of the given 'object_value'.
- * @param object_value Value to use for the modification.
+ * @param home The home to advertise.
+ * @param name The name for the PLACE record to put in the zone.
+ * @param peer_count Number of elements in the @a peers array.
+ * @param peers List of peers in the PLACE record that can be used to send join
+ * requests to.
+ * @param expiration_time Expiration time of the record, use 0 to remove the record.
+ * @param password Password used to encrypt the record.
*/
void
-GNUNET_SOCIAL_home_decorate (struct GNUNET_SOCIAL_Home *home,
- enum GNUNET_PSYC_Operator operation,
- const char *object_name,
- size_t object_value_size,
- const void *object_value);
+GNUNET_SOCIAL_home_advertise (struct GNUNET_SOCIAL_Home *home,
+ const char *name,
+ size_t peer_count,
+ const struct GNUNET_PeerIdentity *peers,
+ GNUNET_TIME_Relative expiration_time,
+ const char *password);
+
+
+/**
+ * Flags for announcements in a home.
+ */
+enum GNUNET_PSYC_AnnouncementFlags
+{
+ /**
+ * Whether this announcement removes all objects from the home.
+ *
+ * New objects can be still added to the now empty home using the @e env
+ * parameter of the same announcement.
+ */
+ GNUNET_SOCIAL_ANNOUNCEMENT_CLEAR_OBJECTS = 1 << 0
+};
-/**
+/**
* Handle for an announcement request.
*/
struct GNUNET_SOCIAL_Announcement;
-/**
+/**
* Send a message to all nyms that are present in the home.
*
- * This function is restricted to the home owner. Nyms can
+ * This function is restricted to the home owner. Nyms can only send requests
+ * to the home owner who can decide to relay it to other guests.
*
* @param home Home to address the announcement to.
- * @param full_method_name Method to use for the announcement.
+ * @param method_name Method to use for the announcement.
+ * @param env Environment containing variables for the message and operations on
+ * objects of the home, or NULL.
* @param notify Function to call to get the payload of the announcement.
- * @param notify_cls Closure for 'notify'.
+ * @param notify_cls Closure for @a notify.
+ * @param flags Flags for this announcement.
* @return NULL on error (announcement already in progress?).
*/
struct GNUNET_SOCIAL_Announcement *
GNUNET_SOCIAL_home_announce (struct GNUNET_SOCIAL_Home *home,
- const char *full_method_name,
- GNUNET_PSYC_OriginReadyNotify notify,
- void *notify_cls);
+ const char *method_name,
+ const struct GNUNET_ENV_Environment *env,
+ GNUNET_CONNECTION_TransmitReadyNotify notify,
+ void *notify_cls,
+ GNUNET_SOCIAL_AnnouncementFlags flags);
-/**
+/**
* Cancel announcement.
*
* @param a The announcement to cancel.
GNUNET_SOCIAL_home_announce_cancel (struct GNUNET_SOCIAL_Announcement *a);
-/**
+/**
* Convert our home to a place so we can access it via the place API.
*
* @param home Handle for the home.
- * @return Place handle for the same home, valid as long as 'home' is valid;
- * do NOT try to 'GNUNET_SOCIAL_place_leave' this place, it's your home!m
+ * @param keep_active Keep home active after last application disconnected.
+ * @return Place handle for the same home, valid as long as @a home is valid;
+ * do NOT try to GNUNET_SOCIAL_place_leave() this place, it's your home!
*/
struct GNUNET_SOCIAL_Place *
-GNUNET_SOCIAL_home_to_place (struct GNUNET_SOCIAL_Home *home);
+GNUNET_SOCIAL_home_get_place (struct GNUNET_SOCIAL_Home *home, int keep_active);
-/**
- * Leave a home, visitors can stay.
- *
- * After leaving, handling of incoming messages are left to other clients of the
- * social service, and stops after the last client exits.
+/**
+ * Leave a home.
+
+ * Invalidates home handle.
+ * Guests will be disconnected until the home is restarted.
*
- * @param home Home to leave (handle becomes invalid).
+ * @param home Home to leave.
*/
void
GNUNET_SOCIAL_home_leave (struct GNUNET_SOCIAL_Home *home);
-
-/**
- * Destroy a home, all guests will be ejected.
+/**
+ * Request entry to a place (home hosted by someone else).
*
- * @param home Home to destroy.
+ * @param cfg Configuration to contact the social service.
+ * @param ego Owner of the home (host).
+ * @param address GNS name of the place to enter. Either in the form of
+ * 'room.friend.gnu', or 'NYMPUBKEY.zkey'. This latter case refers to
+ * the 'PLACE' record of the empty label ("+") in the GNS zone with the
+ * nym's public key 'NYMPUBKEY', and can be used to request entry to a
+ * pseudonym's place directly.
+ * @param method_name Method name for the message.
+ * @param env Environment containing variables for the message, or NULL.
+ * @param data Payload for the message to give to the enter callback.
+ * @param data_size Number of bytes in @a data.
+ * @param slicer Slicer to use for processing incoming requests from guests.
+ * @return NULL on errors, otherwise handle to the place.
*/
-void
-GNUNET_SOCIAL_home_destroy (struct GNUNET_SOCIAL_Home *home);
-
-
-/**
- * Join a place (home hosted by someone else).
+struct GNUNET_SOCIAL_Place *
+GNUNET_SOCIAL_place_enter (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ struct GNUNET_IDENTITY_Ego *ego,
+ char *address,
+ const char *method_name,
+ const struct GNUNET_ENV_Environment *env,
+ const void *data,
+ size_t data_size,
+ struct GNUNET_SOCIAL_Slicer *slicer);
+
+/**
+ * Request entry to a place (home hosted by someone else).
*
* @param cfg Configuration to contact the social service.
* @param ego Owner of the home (host).
- * @param address Address of the place to join (GADS name, i.e. 'room.friend.gads'),
- * if the name has the form 'HEX.place', GADS is not
- * used and HEX is assumed to be the hash of the public
- * key already; 'HEX.zkey' however would refer to
- * the 'PLACE' record in the GADS zone with the public key
- * 'HEX'.
- * @param join_msg_size Number of bytes in 'join_msg'.
- * @param join_msg Message to give to the join callback.
+ * @param crypto_address Public key of the place to enter.
+ * @param origin Peer identity of the origin of the underlying multicast group.
+ * @param relay_count Number of elements in the @a relays array.
+ * @param relays Relays for the underlying multicast group.
+ * @param method_name Method name for the message.
+ * @param env Environment containing variables for the message, or NULL.
+ * @param data Payload for the message to give to the enter callback.
+ * @param data_size Number of bytes in @a data.
+ * @param slicer Slicer to use for processing incoming requests from guests.
* @return NULL on errors, otherwise handle to the place.
*/
struct GNUNET_SOCIAL_Place *
-GNUNET_SOCIAL_place_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_SOCIAL_Ego *ego,
- const char *address,
- struct GNUNET_SOCIAL_Slicer *slicer,
- size_t join_msg_size,
- const void *join_msg);
+GNUNET_SOCIAL_place_enter2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ struct GNUNET_IDENTITY_Ego *ego,
+ struct GNUNET_CRYPTO_EddsaPublicKey *crypto_address,
+ struct GNUNET_PeerIdentity *origin,
+ size_t relay_count,
+ struct GNUNET_PeerIdentity *relays,
+ const char *method_name,
+ const struct GNUNET_ENV_Environment *env,
+ const void *data,
+ size_t data_size,
+ struct GNUNET_SOCIAL_Slicer *slicer);
struct GNUNET_SOCIAL_WatchHandle;
-/**
+/**
* Watch a place for changed objects.
*
* @param place Place to watch.
- * @param object_filter Object prefix to match. if
- * @param state_cb
- * @param state_cb_cls
- *
- * @return
+ * @param object_filter Object prefix to match.
+ * @param state_cb Function to call when an object/state changes.
+ * @param state_cb_cls Closure for callback.
+ *
+ * @return Handle that can be used to cancel watching.
*/
struct GNUNET_SOCIAL_WatchHandle *
GNUNET_SOCIAL_place_watch (struct GNUNET_SOCIAL_Place *place,
- const char *object_filter,
- GNUNET_PSYC_StateCallback state_cb,
- void *state_cb_cls);
+ const char *object_filter,
+ GNUNET_PSYC_StateCallback state_cb,
+ void *state_cb_cls);
+/**
+ * Cancel watching a place for changed objects.
+ *
+ * @param wh Watch handle to cancel.
+ */
void
GNUNET_SOCIAL_place_watch_cancel (struct GNUNET_SOCIAL_WatchHandle *wh);
struct GNUNET_SOCIAL_LookHandle;
-/**
- * Look at all objects in the place.
- *
- * @param place The place to look its objects at.
- * @param state_cb Function to call for each object found.
- * @param state_cb_cls Closure for callback function.
- *
- * @return Handle that can be used to stop looking at objects.
- */
-struct GNUNET_SOCIAL_LookHandle *
-GNUNET_SOCIAL_place_look (struct GNUNET_SOCIAL_Place *place,
- GNUNET_PSYC_StateCallback state_cb,
- void *state_cb_cls);
-
-/**
- * Look at matching objects in the place.
+/**
+ * Look at objects in the place with a matching name prefix.
*
* @param place The place to look its objects at.
- * @param object_filter Only look at objects with names beginning with this filter value.
+ * @param name_prefix Look at objects with names beginning with this value.
* @param state_cb Function to call for each object found.
* @param state_cb_cls Closure for callback function.
- *
+ *
* @return Handle that can be used to stop looking at objects.
*/
struct GNUNET_SOCIAL_LookHandle *
-GNUNET_SOCIAL_place_look_for (struct GNUNET_SOCIAL_Place *place,
- const char *object_filter,
- GNUNET_PSYC_StateCallback state_cb,
- void *state_cb_cls);
+GNUNET_SOCIAL_place_look (struct GNUNET_SOCIAL_Place *place,
+ const char *name_prefix,
+ GNUNET_PSYC_StateCallback state_cb,
+ void *state_cb_cls);
-/**
+/**
* Stop looking at objects.
+ *
+ * @param lh Look handle to stop.
*/
void
GNUNET_SOCIAL_place_look_cancel (struct GNUNET_SOCIAL_LookHandle *lh);
-/**
+/**
* Look at a particular object in the place.
*
+ * The best matching object is returned (its name might be less specific than
+ * what was requested).
+ *
* @param place The place to look the object at.
- * @param object_name Full name of the object.
+ * @param full_name Full name of the object.
* @param value_size Set to the size of the returned value.
* @return NULL if there is no such object at this place.
*/
const void *
GNUNET_SOCIAL_place_look_at (struct GNUNET_SOCIAL_Place *place,
- const char *object_name,
- size_t *value_size);
+ const char *full_name,
+ size_t *value_size);
-/**
- * Frame the (next) talk by setting some variables for it.
- *
- * FIXME: use a TalkFrame struct instead that can be passed to
- * place_talk, nym_talk and home_reject_entry.
- *
- * @param place Place to talk in.
- * @param variable_name Name of variable to set.
- * @param value_size Number of bytes in 'value'.
- * @param value Value of variable.
+/**
+ * Flags for talking to the host of a place.
*/
-void
-GNUNET_SOCIAL_place_frame_talk (struct GNUNET_SOCIAL_Place *place,
- const char *variable_name,
- size_t value_size,
- const void *value);
+enum GNUNET_SOCIAL_TalkFlags;
-/**
+/**
* A talk request.
*/
struct GNUNET_SOCIAL_TalkRequest;
-
-/**
+/**
* Talk to the host of the place.
*
* @param place Place where we want to talk to the host.
* @param method_name Method to invoke on the host.
- * @param cb Function to use to get the payload for the method.
- * @param cb_cls Closure for 'cb'.
+ * @param env Environment containing variables for the message, or NULL.
+ * @param notify Function to use to get the payload for the method.
+ * @param notify_cls Closure for @a notify.
+ * @param flags Flags for the message being sent.
* @return NULL if we are already trying to talk to the host,
* otherwise handle to cancel the request.
*/
struct GNUNET_SOCIAL_TalkRequest *
GNUNET_SOCIAL_place_talk (struct GNUNET_SOCIAL_Place *place,
- const char *method_name,
- GNUNET_PSYC_OriginReadyNotify cb,
- void *cb_cls);
-
-/**
- * Talk to a nym.
- *
- * FIXME: look up nym in GADS and talk to its place.
- *
- * @param nym Nym we want to talk to.
- * @param method_name Method to invoke on the nym.
- * @param cb Function to use to get the payload for the method.
- * @param cb_cls Closure for 'cb'.
- * @return NULL if we are already trying to talk to the host,
- * otherwise handle to cancel the request.
- */
-struct GNUNET_SOCIAL_TalkRequest *
-GNUNET_SOCIAL_nym_talk (struct GNUNET_SOCIAL_Nym *nym,
- const char *method_name,
- GNUNET_PSYC_OriginReadyNotify cb,
- void *cb_cls);
+ const char *method_name,
+ const struct GNUNET_ENV_Environment *env,
+ GNUNET_CONNECTION_TransmitReadyNotify notify,
+ void *notify_cls,
+ GNUNET_SOCIAL_TalkFlags flags);
-/**
+/**
* Cancel talking to the host of the place.
*
* @param tr Talk request to cancel.
*/
void
GNUNET_SOCIAL_place_talk_cancel (struct GNUNET_SOCIAL_TalkRequest *tr);
-
-/**
+
+/**
* A history lesson.
*/
struct GNUNET_SOCIAL_HistoryLesson;
-
-/**
+/**
* Learn about the history of a place.
*
- * Sends messages through the given slicer function where
+ * Sends messages through the slicer function of the place where
* start_message_id <= message_id <= end_message_id.
- *
+ * The messages will have the #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
+ *
+ * To get the latest message, use 0 for both the start and end message ID.
+ *
* @param place Place we want to learn more about.
* @param start_message_id First historic message we are interested in.
* @param end_message_id Last historic message we are interested in (inclusive).
- * @param slicer Slicer to use to process history.
+ * @param slicer Slicer to use to process history. Can be the same as the
+ * slicer of the place, as the HISTORIC flag allows distinguishing
+ * old messages from fresh ones.
+ * @param finish_cb Function called after the last message if the history lesson
+ * is passed through the @a slicer. NULL if not needed.
+ * @param finish_cb_cls Closure for @a finish_cb.
* @return Handle to abort history lesson, never NULL (multiple lessons
- * at the same time are allowed).
+ * at the same time are allowed).
*/
struct GNUNET_SOCIAL_HistoryLesson *
GNUNET_SOCIAL_place_get_history (struct GNUNET_SOCIAL_Place *place,
- uint64_t start_message_id,
- uint64_t end_message_id,
- struct GNUNET_SOCIAL_Slicer *slicer);
+ uint64_t start_message_id,
+ uint64_t end_message_id,
+ const struct GNUNET_SOCIAL_Slicer *slicer,
+ void (*finish_cb)(void *),
+ void *finish_cb_cls);
-/**
+/**
* Stop processing messages from the history lesson.
*
- * Must also be called explicitly after all of the requested messages have been
- * received.
+ * Must not be called after the finish callback of the history lesson is called.
*
* @param hist History lesson to cancel.
*/
void
GNUNET_SOCIAL_place_get_history_cancel (struct GNUNET_SOCIAL_HistoryLesson *hist);
-
-/**
- * Leave a place (destroys the place handle).
- *
- * Can either move our user into an 'away' state (in which we continue to record
- * ongoing conversations and state changes if our peer is running), or leave the
- * place entirely and stop following the conversation.
+
+/**
+ * Leave a place permanently.
*
- * @param place Place to leave.
- * @param keep_following GNUNET_YES to ask the social service to continue
- * to follow the conversation, GNUNET_NO to fully leave the place.
+ * Notifies the owner of the place about leaving, and destroys the place handle.
+ *
+ * @param place Place to leave permanently.
+ * @param keep_active Keep place active after last application disconnected.
*/
void
-GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place,
- int keep_following);
-
+GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place, int keep_active);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff