Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @file include/gnunet_social_service.h
* @brief Social service; implements social functionality using the PSYC service.
* @author Gabor X Toth
#include "gnunet_multicast_service.h"
-/**
+/**
* Version number of GNUnet Social API.
*/
#define GNUNET_SOCIAL_VERSION 0x00000000
-/**
+/**
* 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 @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 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_size Number of bytes in @a data.
* @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,
- const char *full_method_name,
- uint64_t message_id,
- size_t modifier_count,
- GNUNET_PSYC_Modifier *modifiers,
- uint64_t data_offset,
- size_t data_size,
- const void *data,
- enum GNUNET_PSYC_MessageFlags flags);
+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 *method_cls);
-/**
+/**
* Remove a registered method from the try-and-slice instance.
*
* @param slicer The try-and-slice instance.
const char *method_name,
GNUNET_SOCIAL_Method method);
-/**
+/**
* Destroy a given try-and-slice instance.
*
* @param slicer slicer to destroy
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
* @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_size Number of bytes in @a data.
* @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 variable_count,
- const char *method_name,
- GNUNET_PSYC_Modifier *variables,
- size_t data_size,
- const void *data);
+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 @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 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,
- size_t variable_count,
- GNUNET_PSYC_Modifier *variables);
+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
void *cls);
-/**
+/**
* Admit @a nym to the @a home.
*
* The @a nym reference will remain valid until either the home is destroyed or
struct GNUNET_SOCIAL_Nym *nym);
-/**
+/**
* Throw @a nym out of the @a home.
*
* The @a nym reference will remain valid until the
struct GNUNET_SOCIAL_Nym *nym);
-/**
+/**
* Refuse @a nym entry into the @a home.
*
* @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_size Number of bytes in @a data for method.
* @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_name,
const struct GNUNET_ENV_Environment *env,
- size_t data_size,
- const void *data);
+ const void *data,
+ size_t data_size);
-/**
+/**
* Get the public key of a nym.
*
* Suitable, for example, to be used with GNUNET_NAMESTORE_zone_to_name().
*/
void
GNUNET_SOCIAL_nym_get_key (struct GNUNET_SOCIAL_Nym *nym,
- struct GNUNET_CRYPTO_EccPublicKey *nym_key);
+ struct GNUNET_CRYPTO_EddsaPublicKey *nym_key);
-/**
+/**
* 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 GADS within a "PLACE" record, along with peer IDs to join at.
+ * @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_key (struct GNUNET_SOCIAL_Home *home,
- struct GNUNET_CRYPTO_EccPrivateKey *home_key);
+ struct GNUNET_CRYPTO_EddsaPrivateKey *home_key);
-/**
- * Advertise @a home under @a name in the GADS zone of the @e ego.
+/**
+ * Advertise @a home under @a name in the GNS zone of the @e ego.
*
* @param home The home to advertise.
* @param name The name for the PLACE record to put in the zone.
*/
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.
*/
};
-/**
+/**
* 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 only send requests
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.
+ * @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_get_place (struct GNUNET_SOCIAL_Home *home);
-
-
-/**
- * Leave a home temporarily, 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.
- *
- * @param home Home to leave temporarily (handle becomes invalid).
- */
-void
-GNUNET_SOCIAL_home_away (struct GNUNET_SOCIAL_Home *home);
+GNUNET_SOCIAL_home_get_place (struct GNUNET_SOCIAL_Home *home, int keep_active);
-/**
+/**
* Leave a home.
* Invalidates home handle.
void
GNUNET_SOCIAL_home_leave (struct GNUNET_SOCIAL_Home *home);
-/**
+/**
* 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 GADS name of the place to enter. Either in the form of
+ * @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 GADS zone with the
+ * 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_size Number of bytes in @a data.
* @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.
*/
char *address,
const char *method_name,
const struct GNUNET_ENV_Environment *env,
- size_t data_size,
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 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_size Number of bytes in @a data.
* @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_enter2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
struct GNUNET_IDENTITY_Ego *ego,
- struct GNUNET_CRYPTO_EccPublicKey *crypto_address,
+ struct GNUNET_CRYPTO_EddsaPublicKey *crypto_address,
struct GNUNET_PeerIdentity *origin,
- size_t count_relays,
+ size_t relay_count,
struct GNUNET_PeerIdentity *relays,
const char *method_name,
const struct GNUNET_ENV_Environment *env,
- size_t data_size,
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.
* @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 *
void *state_cb_cls);
-/**
+/**
* Cancel watching a place for changed objects.
*
* @param wh Watch handle to cancel.
struct GNUNET_SOCIAL_LookHandle;
-/**
- * Look at all 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 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 (struct GNUNET_SOCIAL_Place *place,
+ const char *name_prefix,
GNUNET_PSYC_StateCallback state_cb,
void *state_cb_cls);
-/**
- * Look at matching objects in the place.
- *
- * @param place The place to look its objects at.
- * @param object_filter Only look at objects with names beginning with this filter 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);
-
-
-/**
+/**
* Stop looking at objects.
*
* @param lh Look handle to stop.
-/**
+/**
* 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,
+ const char *full_name,
size_t *value_size);
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.
GNUNET_SOCIAL_TalkFlags flags);
-/**
+/**
* Cancel talking to the host of the place.
*
* @param tr Talk request to cancel.
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 slicer function of the place where
* 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).
void *finish_cb_cls);
-/**
+/**
* Stop processing messages from the history lesson.
*
* Must not be called after the finish callback of the history lesson is called.
GNUNET_SOCIAL_place_get_history_cancel (struct GNUNET_SOCIAL_HistoryLesson *hist);
-/**
+/**
* Leave a place permanently.
*
* Notifies the owner of the place about leaving, and destroys the place handle.
- *
- * @param place Place to leave permanently.
- */
-void
-GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place);
-
-
-/**
- * Leave a place temporarily.
*
- * Stop following the conversation for the @a place and destroy the @a place
- * handle. Only affects the application calling this function, other clients of
- * the service continue receiving the messages.
- *
- * @param place Place to leave temporarily.
+ * @param place Place to leave permanently.
+ * @param keep_active Keep place active after last application disconnected.
*/
void
-GNUNET_SOCIAL_place_away (struct GNUNET_SOCIAL_Place *place);
+GNUNET_SOCIAL_place_leave (struct GNUNET_SOCIAL_Place *place, int keep_active);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff