2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Gabor X Toth
23 * @author Christian Grothoff
26 * Social service; implements social interactions through the PSYC service.
29 /** @defgroup social Social service
30 Social interactions through the PSYC service.
34 The social service provides an API for social interactions based on a one-to-many messaging model.
35 It manages subscriptions of applications to places, provides messaging functionality in places,
36 allows access to the local message history and manages the GNS zone of _egos_ (user identities).
38 The service stores private and public keys of subscribed places, as well as files received in subscribed places.
40 # Concepts and terminology
44 An _ego_ is an identity of a user, a private-public key pair.
45 A _nym_ is an identity of another user in the network, identified by its public key.
46 Each user can have multiple identities.
48 struct GNUNET_SOCIAL_Ego and struct GNUNET_SOCIAL_Nym represents one of these identities.
52 A _place_ is where social interactions happen. It is owned and created by an _ego_.
53 Creating a new place happens by an _ego_ entering a new place as a _host_,
54 where _guests_ can enter later to receive messages sent to the place.
56 A place is identified by its public key.
58 - struct GNUNET_SOCIAL_Host represents a place entered as host,
59 - struct GNUNET_SOCIAL_Guest is used for a place entered as guest.
60 - A struct GNUNET_SOCIAL_Place can be obtained for both a host and guest place
61 using GNUNET_SOCIAL_host_get_place() and GNUNET_SOCIAL_guest_get_place()
62 and can be used with API functions common to hosts and guests.
66 Messages sent to places are stored locally by the PSYCstore service, and can be queried any time.
67 GNUNET_SOCIAL_history_replay_latest() retrieves the latest N messages sent to the place,
68 while GNUNET_SOCIAL_history_replay() is used to query a given message ID range.
72 The GNU Name System is used for assigning human-readable names to nyms and places.
73 There's a _GNS zone_ corresponding to each _nym_.
74 An _ego_ can publish PKEY and PLACE records in its own zone, pointing to nyms and places, respectively.
76 ## Announcement, talk request
78 The host can _announce_ messages to the place, using GNUNET_SOCIAL_host_announce().
79 Guests can send _talk_ requests to the host, using GNUNET_SOCIAL_guest_talk().
80 The host receives talk requests of guests and can _relay_ them to the place,
81 or process it using a message handler function.
85 ## Connecting to the service
87 A client first establishes an _application connection_ to the service using
88 GNUNET_SOCIAL_app_connect() providing its _application ID_, then receives the
89 public keys of subscribed places and available egos in response.
91 ## Reconnecting to places
93 Then the application can reconnect to its subscribed places by establishing
94 _place connections_ with GNUNET_SOCIAL_host_enter_reconnect() and
95 GNUNET_SOCIAL_guest_enter_reconnect().
97 ## Subscribing to a place
99 Entering and subscribing a new host or guest place is done using
100 GNUNET_SOCIAL_host_enter() and GNUNET_SOCIAL_guest_enter().
102 ## Disconnecting from a place
104 An application can disconnect from a place while the social service keeps its
105 network connection active, using GNUNET_SOCIAL_host_disconnect() and
106 GNUNET_SOCIAL_guest_disconnect().
110 To permanently leave a place, see GNUNET_SOCIAL_host_leave() and GNUNET_SOCIAL_guest_leave().
111 When leaving a place its network connections are closed and all applications are unsubscribed from the place.
117 Human conversation in a private or public place.
122 Message ID this message is in reply to.
125 Thread ID, the first message ID in the thread.
130 FIXME: Are nyms a different data type from egos and person entities?
131 Do they have a different format than any other entity address?
132 Questions and thoughts on how to fix this in "questions.org"
135 Signature of the message body and its variables by the author.
143 Notification about a place.
145 TODO: Applications can decide to auto-subscribe to certain places,
146 e.g. files under a given size.
153 GNS name of the place in a globally unique .zkey zone
155 FIXME: A custom _gns PSYC data type should be avoidable by parsing
156 and interpreting PSYC uniforms appropriately.
157 Thoughts on this in "questions.org"
164 FIXME: _key_pub can't be the data type for GNUnet-specific cryptographic
165 addressing. Questions and thoughts on how to fix this in "questions.org"
170 ##### _list_peer_relays
171 List of peer IDs of relays
173 ## _notice_place_file
175 Notification about a place hosting a file.
179 The environment of _notice_place above, plus the following:
190 #### _description_file
195 Messages with a _file method contain a file,
196 which is saved to disk upon reception at the following location:
197 $GNUNET_DATA_HOME/social/files/<H(place_pub)>/<message_id>
210 #### _description_file
217 #ifndef GNUNET_SOCIAL_SERVICE_H
218 #define GNUNET_SOCIAL_SERVICE_H
223 #if 0 /* keep Emacsens' auto-indent happy */
229 #include "gnunet_util_lib.h"
230 #include "gnunet_psyc_util_lib.h"
231 #include "gnunet_identity_service.h"
232 #include "gnunet_namestore_service.h"
233 #include "gnunet_psyc_service.h"
237 * Version number of GNUnet Social API.
239 #define GNUNET_SOCIAL_VERSION 0x00000000
242 * Maximum size of client ID including '\0' terminator.
244 #define GNUNET_SOCIAL_APP_MAX_ID_SIZE 256
246 enum GNUNET_SOCIAL_MsgProcFlags {
247 GNUNET_SOCIAL_MSG_PROC_NONE = 0,
248 GNUNET_SOCIAL_MSG_PROC_RELAY = 1,
249 GNUNET_SOCIAL_MSG_PROC_SAVE= 2,
253 * Handle for an application.
255 struct GNUNET_SOCIAL_App;
258 * Handle for an ego (own identity)
260 struct GNUNET_SOCIAL_Ego;
263 * Handle for a pseudonym of another user in the network.
265 struct GNUNET_SOCIAL_Nym;
268 * Handle for a place where social interactions happen.
270 struct GNUNET_SOCIAL_Place;
273 * Host handle for a place that we entered.
275 struct GNUNET_SOCIAL_Host;
278 * Guest handle for place that we entered.
280 struct GNUNET_SOCIAL_Guest;
283 * Handle that can be used to reconnect to a place as host.
285 struct GNUNET_SOCIAL_HostConnection;
288 * Handle that can be used to reconnect to a place as guest.
290 struct GNUNET_SOCIAL_GuestConnection;
293 * Notification about an available identity.
303 (*GNUNET_SOCIAL_AppEgoCallback) (void *cls,
304 struct GNUNET_SOCIAL_Ego *ego,
305 const struct GNUNET_CRYPTO_EcdsaPublicKey *ego_pub_key,
310 * Entry status of a place per application.
312 enum GNUNET_SOCIAL_AppPlaceState
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 GNUNET_SOCIAL_PLACE_STATE_ARCHIVED = 0,
323 * The place is entered by the ego,
324 * but this application is not subscribed to it.
326 GNUNET_SOCIAL_PLACE_STATE_ENTERED = 1,
329 * The place is entered by the ego and
330 * and this application is subscribed to it.
332 GNUNET_SOCIAL_PLACE_STATE_SUBSCRIBED = 2,
337 * Called after receiving initial list of egos and places.
340 (*GNUNET_SOCIAL_AppConnectedCallback) (void *cls);
344 * Notification about a home.
349 * Host connection, to be used with GNUNET_SOCIAL_host_enter_reconnect()
351 * Ego used to enter the place.
352 * @param place_pub_key
353 * Public key of the place.
355 * @see enum GNUNET_SOCIAL_AppPlaceState
358 (*GNUNET_SOCIAL_AppHostPlaceCallback) (void *cls,
359 struct GNUNET_SOCIAL_HostConnection *hconn,
360 struct GNUNET_SOCIAL_Ego *ego,
361 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
362 enum GNUNET_SOCIAL_AppPlaceState place_state);
365 * Notification about a place.
370 * Guest connection, to be used with GNUNET_SOCIAL_guest_enter_reconnect()
372 * Ego used to enter the place.
373 * @param place_pub_key
374 * Public key of the place.
376 * @see enum GNUNET_SOCIAL_AppPlaceState
379 (*GNUNET_SOCIAL_AppGuestPlaceCallback) (void *cls,
380 struct GNUNET_SOCIAL_GuestConnection *gconn,
381 struct GNUNET_SOCIAL_Ego *ego,
382 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
383 enum GNUNET_SOCIAL_AppPlaceState place_state);
387 * Establish application connection to the social service.
389 * The @host_place_cb and @guest_place_cb functions are
390 * initially called for each entered places,
391 * then later each time a new place is entered with the current app ID.
396 * Function to notify about an available ego.
398 * Function to notify about a place entered as host.
400 * Function to notify about a place entered as guest.
402 * Closure for the callbacks.
404 * @return Handle that can be used to stop listening.
406 struct GNUNET_SOCIAL_App *
407 GNUNET_SOCIAL_app_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
409 GNUNET_SOCIAL_AppEgoCallback ego_cb,
410 GNUNET_SOCIAL_AppHostPlaceCallback host_cb,
411 GNUNET_SOCIAL_AppGuestPlaceCallback guest_cb,
412 GNUNET_SOCIAL_AppConnectedCallback connected_cb,
423 GNUNET_SOCIAL_app_disconnect (struct GNUNET_SOCIAL_App *app,
424 GNUNET_ContinuationCallback disconnect_cb,
425 void *disconnect_cls);
429 * Get the public key of @a ego.
434 * @return Public key of ego.
436 const struct GNUNET_CRYPTO_EcdsaPublicKey *
437 GNUNET_SOCIAL_ego_get_pub_key (const struct GNUNET_SOCIAL_Ego *ego);
441 * Get the name of @a ego.
446 * @return Public key of @a ego.
449 GNUNET_SOCIAL_ego_get_name (const struct GNUNET_SOCIAL_Ego *ego);
453 * Get the public key of a @a nym.
455 * Suitable, for example, to be used with GNUNET_SOCIAL_zone_add_nym().
458 * Pseudonym to map to a cryptographic identifier.
460 * @return Public key of nym.
462 const struct GNUNET_CRYPTO_EcdsaPublicKey *
463 GNUNET_SOCIAL_nym_get_pub_key (const struct GNUNET_SOCIAL_Nym *nym);
467 * Get the hash of the public key of a @a nym.
470 * Pseudonym to map to a cryptographic identifier.
472 * @return Hash of the public key of nym.
474 const struct GNUNET_HashCode *
475 GNUNET_SOCIAL_nym_get_pub_key_hash (const struct GNUNET_SOCIAL_Nym *nym);
479 * Function called asking for nym to be admitted to the place.
481 * Should call either GNUNET_SOCIAL_host_admit() or
482 * GNUNET_SOCIAL_host_reject_entry() (possibly asynchronously). If this host
483 * cannot decide, it is fine to call neither function, in which case hopefully
484 * some other host of the place exists that will make the decision. The @a nym
485 * reference remains valid until the #GNUNET_SOCIAL_FarewellCallback is invoked
491 * Handle for the user who wants to enter.
493 * Method name in the entry request.
494 * @param variable_count
495 * Number of elements in the @a variables array.
497 * Variables present in the message.
499 * Payload given on enter (e.g. a password).
501 * Number of bytes in @a data.
504 (*GNUNET_SOCIAL_AnswerDoorCallback) (void *cls,
505 struct GNUNET_SOCIAL_Nym *nym,
506 const char *method_name,
507 struct GNUNET_PSYC_Environment *env,
513 * Function called when a @a nym leaves the place.
515 * This is also called if the @a nym was never given permission to enter
516 * (i.e. the @a nym stopped asking to get in).
521 * Handle for the user who left.
524 (*GNUNET_SOCIAL_FarewellCallback) (void *cls,
525 const struct GNUNET_SOCIAL_Nym *nym,
526 struct GNUNET_PSYC_Environment *env);
530 * Function called after the host entered a home.
535 * #GNUNET_OK on success, or
536 * #GNUNET_SYSERR on error.
537 * @param place_pub_key
538 * Public key of home.
539 * @param max_message_id
540 * Last message ID sent to the channel.
541 * Or 0 if no messages have been sent to the place yet.
544 (*GNUNET_SOCIAL_HostEnterCallback) (void *cls, int result,
545 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
546 uint64_t max_message_id);
550 * Enter a place as host.
552 * A place is created upon first entering, and it is active until permanently
553 * left using GNUNET_SOCIAL_host_leave().
556 * Configuration to contact the social service.
558 * Identity of the host.
560 * Private-public key pair of the place.
561 * NULL for ephemeral places.
563 * Policy specifying entry and history restrictions for the place.
565 * Slicer to handle incoming messages.
567 * Function called when the place is entered and ready to use.
568 * @param answer_door_cb
569 * Function to handle new nyms that want to enter.
571 * Function to handle departing nyms.
573 * Closure for the callbacks.
575 * @return Handle for the host.
577 struct GNUNET_SOCIAL_Host *
578 GNUNET_SOCIAL_host_enter (const struct GNUNET_SOCIAL_App *app,
579 const struct GNUNET_SOCIAL_Ego *ego,
580 enum GNUNET_PSYC_Policy policy,
581 struct GNUNET_PSYC_Slicer *slicer,
582 GNUNET_SOCIAL_HostEnterCallback enter_cb,
583 GNUNET_SOCIAL_AnswerDoorCallback answer_door_cb,
584 GNUNET_SOCIAL_FarewellCallback farewell_cb,
589 * Reconnect to an already entered place as host.
592 * Host connection handle.
593 * @see GNUNET_SOCIAL_app_connect() & GNUNET_SOCIAL_AppHostPlaceCallback()
595 * Slicer to handle incoming messages.
597 * Function called when the place is entered and ready to use.
598 * @param answer_door_cb
599 * Function to handle new nyms that want to enter.
601 * Function to handle departing nyms.
603 * Closure for the callbacks.
605 * @return Handle for the host.
607 struct GNUNET_SOCIAL_Host *
608 GNUNET_SOCIAL_host_enter_reconnect (struct GNUNET_SOCIAL_HostConnection *hconn,
609 struct GNUNET_PSYC_Slicer *slicer,
610 GNUNET_SOCIAL_HostEnterCallback enter_cb,
611 GNUNET_SOCIAL_AnswerDoorCallback answer_door_cb,
612 GNUNET_SOCIAL_FarewellCallback farewell_cb,
617 * Decision whether to admit @a nym into the place or refuse entry.
622 * Handle for the entity that wanted to enter.
624 * #GNUNET_YES if @a nym is admitted,
625 * #GNUNET_NO if @a nym is refused entry,
626 * #GNUNET_SYSERR if we cannot answer the request.
628 * Entry response message, or NULL.
629 * @return #GNUNET_OK on success,
630 * #GNUNET_SYSERR if the message is too large.
633 GNUNET_SOCIAL_host_entry_decision (struct GNUNET_SOCIAL_Host *hst,
634 struct GNUNET_SOCIAL_Nym *nym,
636 const struct GNUNET_PSYC_Message *entry_resp);
640 * Throw @a nym out of the place.
642 * Sends a _notice_place_leave announcement to the home.
644 * The @a nym reference will remain valid until the
645 * #GNUNET_SOCIAL_FarewellCallback is invoked,
646 * which should be very soon after this call.
651 * Handle for the entity to be ejected.
653 * Environment for the message or NULL.
654 * _nym is set to @e nym regardless whether an @e env is provided.
657 GNUNET_SOCIAL_host_eject (struct GNUNET_SOCIAL_Host *host,
658 const struct GNUNET_SOCIAL_Nym *nym,
659 struct GNUNET_PSYC_Environment *env);
663 * Flags for announcements by a host.
665 enum GNUNET_SOCIAL_AnnounceFlags
667 GNUNET_SOCIAL_ANNOUNCE_NONE = 0,
670 * Whether this announcement removes all objects from the place.
672 * New objects can be still added to the now empty place using the @e env
673 * parameter of the same announcement.
675 GNUNET_SOCIAL_ANNOUNCE_CLEAR_OBJECTS = 1 << 0
680 * Handle for an announcement request.
682 struct GNUNET_SOCIAL_Announcement;
686 * Send a message to all nyms that are present in the place.
688 * This function is restricted to the host. Nyms can only send requests
689 * to the host who can decide to relay it to everyone in the place.
694 * Method to use for the announcement.
696 * Environment containing variables for the message and operations
697 * on objects of the place.
698 * Has to remain available until the first call to @a notify_data.
701 * Function to call to get the payload of the announcement.
702 * @param notify_data_cls
703 * Closure for @a notify.
705 * Flags for this announcement.
707 * @return NULL on error (another announcement already in progress?).
709 struct GNUNET_SOCIAL_Announcement *
710 GNUNET_SOCIAL_host_announce (struct GNUNET_SOCIAL_Host *host,
711 const char *method_name,
712 const struct GNUNET_PSYC_Environment *env,
713 GNUNET_PSYC_TransmitNotifyData notify_data,
714 void *notify_data_cls,
715 enum GNUNET_SOCIAL_AnnounceFlags flags);
719 * Resume transmitting announcement.
722 * The announcement to resume.
725 GNUNET_SOCIAL_host_announce_resume (struct GNUNET_SOCIAL_Announcement *a);
729 * Cancel announcement.
732 * The announcement to cancel.
735 GNUNET_SOCIAL_host_announce_cancel (struct GNUNET_SOCIAL_Announcement *a);
739 * Allow relaying messages from guests matching a given @a method_prefix.
743 * @param method_prefix
744 * Method prefix to allow.
747 GNUNET_SOCIAL_host_relay_allow_method (struct GNUNET_SOCIAL_Host *host,
748 const char *method_prefix);
752 * Allow relaying changes to objects of the place.
754 * Only applies to messages with an allowed method name.
755 * @see GNUNET_SCOIAL_host_relay_allow_method()
759 * @param object_prefix
760 * Object prefix to allow modifying.
763 GNUNET_SOCIAL_host_relay_allow_method (struct GNUNET_SOCIAL_Host *host,
764 const char *object_prefix);
768 * Stop relaying messages from guests.
770 * Remove all allowed relay rules.
776 GNUNET_SOCIAL_host_relay_stop (struct GNUNET_SOCIAL_Host *host);
780 * Obtain handle for a hosted place.
782 * The returned handle can be used to access the place API.
785 * Handle for the host.
787 * @return Handle for the hosted place, valid as long as @a host is valid.
789 struct GNUNET_SOCIAL_Place *
790 GNUNET_SOCIAL_host_get_place (struct GNUNET_SOCIAL_Host *host);
794 * Disconnect from a home.
796 * Invalidates host handle.
799 * The host to disconnect.
800 * @param disconnect_cb
801 * Function called after disconnected from the service.
803 * Closure for @a disconnect_cb.
806 GNUNET_SOCIAL_host_disconnect (struct GNUNET_SOCIAL_Host *hst,
807 GNUNET_ContinuationCallback disconnect_cb,
812 * Stop hosting a home.
814 * Sends a _notice_place_closing announcement to the home.
815 * Invalidates host handle.
820 * Environment for the message or NULL.
821 * @param disconnect_cb
822 * Function called after the host left the place
823 * and disconnected from the service.
825 * Closure for @a disconnect_cb.
828 GNUNET_SOCIAL_host_leave (struct GNUNET_SOCIAL_Host *hst,
829 const struct GNUNET_PSYC_Environment *env,
830 GNUNET_ContinuationCallback disconnect_cb,
835 * Function called after the guest entered the local copy of the place.
837 * History and object query functions can be used after this call,
838 * but new messages can't be sent or received.
843 * #GNUNET_OK on success, or
844 * #GNUNET_SYSERR on error, e.g. could not connect to the service, or
845 * could not resolve GNS name.
846 * @param place_pub_key
847 * Public key of place.
848 * @param max_message_id
849 * Last message ID sent to the place.
850 * Or 0 if no messages have been sent to the place yet.
853 (*GNUNET_SOCIAL_GuestEnterCallback) (void *cls, int result,
854 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
855 uint64_t max_message_id);
859 * Function called upon a guest receives a decision about entry to the place.
862 * Is the guest admitted to the place?
863 * #GNUNET_YES if admitted,
864 * #GNUNET_NO if refused entry,
865 * #GNUNET_SYSERR if the request could not be answered.
867 * Entry response message.
870 (*GNUNET_SOCIAL_EntryDecisionCallback) (void *cls,
872 const struct GNUNET_PSYC_Message *entry_resp);
876 * Request entry to a place as a guest.
879 * Application handle.
881 * Identity of the guest.
882 * @param place_pub_key
883 * Public key of the place to enter.
885 * Flags for the entry.
887 * Peer identity of the origin of the underlying multicast group.
889 * Number of elements in the @a relays array.
891 * Relays for the underlying multicast group.
895 * Slicer to use for processing incoming requests from guests.
897 * @return NULL on errors, otherwise handle for the guest.
899 struct GNUNET_SOCIAL_Guest *
900 GNUNET_SOCIAL_guest_enter (const struct GNUNET_SOCIAL_App *app,
901 const struct GNUNET_SOCIAL_Ego *ego,
902 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
903 enum GNUNET_PSYC_SlaveJoinFlags flags,
904 const struct GNUNET_PeerIdentity *origin,
905 uint32_t relay_count,
906 const struct GNUNET_PeerIdentity *relays,
907 const struct GNUNET_PSYC_Message *entry_msg,
908 struct GNUNET_PSYC_Slicer *slicer,
909 GNUNET_SOCIAL_GuestEnterCallback local_enter_cb,
910 GNUNET_SOCIAL_EntryDecisionCallback entry_dcsn_cb,
915 * Request entry to a place by name as a guest.
918 * Application handle.
920 * Identity of the guest.
922 * GNS name of the place to enter. Either in the form of
923 * 'room.friend.gnu', or 'NYMPUBKEY.zkey'. This latter case refers to
924 * the 'PLACE' record of the empty label ("+") in the GNS zone with the
925 * nym's public key 'NYMPUBKEY', and can be used to request entry to a
926 * pseudonym's place directly.
928 * Password to decrypt the record, or NULL for cleartext records.
930 * Entry request message.
932 * Slicer to use for processing incoming requests from guests.
933 * @param local_enter_cb
934 * Called upon connection established to the social service.
935 * @param entry_decision_cb
936 * Called upon receiving entry decision.
938 * @return NULL on errors, otherwise handle for the guest.
940 struct GNUNET_SOCIAL_Guest *
941 GNUNET_SOCIAL_guest_enter_by_name (const struct GNUNET_SOCIAL_App *app,
942 const struct GNUNET_SOCIAL_Ego *ego,
943 const char *gns_name,
944 const char *password,
945 const struct GNUNET_PSYC_Message *join_msg,
946 struct GNUNET_PSYC_Slicer *slicer,
947 GNUNET_SOCIAL_GuestEnterCallback local_enter_cb,
948 GNUNET_SOCIAL_EntryDecisionCallback entry_decision_cb,
953 * Reconnect to an already entered place as guest.
956 * Guest connection handle.
957 * @see GNUNET_SOCIAL_app_connect() & GNUNET_SOCIAL_AppGuestPlaceCallback()
959 * Flags for the entry.
961 * Slicer to use for processing incoming requests from guests.
962 * @param local_enter_cb
963 * Called upon connection established to the social service.
964 * @param entry_decision_cb
965 * Called upon receiving entry decision.
967 * @return NULL on errors, otherwise handle for the guest.
969 struct GNUNET_SOCIAL_Guest *
970 GNUNET_SOCIAL_guest_enter_reconnect (struct GNUNET_SOCIAL_GuestConnection *gconn,
971 enum GNUNET_PSYC_SlaveJoinFlags flags,
972 struct GNUNET_PSYC_Slicer *slicer,
973 GNUNET_SOCIAL_GuestEnterCallback local_enter_cb,
978 * Flags for talking to the host of a place.
980 enum GNUNET_SOCIAL_TalkFlags
982 GNUNET_SOCIAL_TALK_NONE = 0
989 struct GNUNET_SOCIAL_TalkRequest;
993 * Talk to the host of the place.
996 * Place where we want to talk to the host.
998 * Method to invoke on the host.
1000 * Environment containing variables for the message, or NULL.
1001 * @param notify_data
1002 * Function to use to get the payload for the method.
1003 * @param notify_data_cls
1004 * Closure for @a notify_data.
1006 * Flags for the message being sent.
1008 * @return NULL if we are already trying to talk to the host,
1009 * otherwise handle to cancel the request.
1011 struct GNUNET_SOCIAL_TalkRequest *
1012 GNUNET_SOCIAL_guest_talk (struct GNUNET_SOCIAL_Guest *guest,
1013 const char *method_name,
1014 const struct GNUNET_PSYC_Environment *env,
1015 GNUNET_PSYC_TransmitNotifyData notify_data,
1016 void *notify_data_cls,
1017 enum GNUNET_SOCIAL_TalkFlags flags);
1021 * Resume talking to the host of the place.
1024 * Talk request to resume.
1027 GNUNET_SOCIAL_guest_talk_resume (struct GNUNET_SOCIAL_TalkRequest *tr);
1031 * Cancel talking to the host of the place.
1034 * Talk request to cancel.
1037 GNUNET_SOCIAL_guest_talk_cancel (struct GNUNET_SOCIAL_TalkRequest *tr);
1041 * Disconnect from a place.
1043 * Invalidates guest handle.
1046 * The guest to disconnect.
1047 * @param disconnect_cb
1048 * Function called after disconnected from the service.
1050 * Closure for @a disconnect_cb.
1053 GNUNET_SOCIAL_guest_disconnect (struct GNUNET_SOCIAL_Guest *gst,
1054 GNUNET_ContinuationCallback disconnect_cb,
1059 * Leave a place temporarily or permanently.
1061 * Notifies the owner of the place about leaving, and destroys the place handle.
1066 * Optional environment for the leave message if @a keep_active
1067 * is #GNUNET_NO. NULL if not needed.
1068 * @param disconnect_cb
1069 * Called upon disconnecting from the social service.
1072 GNUNET_SOCIAL_guest_leave (struct GNUNET_SOCIAL_Guest *gst,
1073 struct GNUNET_PSYC_Environment *env,
1074 GNUNET_ContinuationCallback disconnect_cb,
1079 * Obtain handle for a place entered as guest.
1081 * The returned handle can be used to access the place API.
1083 * @param guest Handle for the guest.
1085 * @return Handle for the place, valid as long as @a guest is valid.
1087 struct GNUNET_SOCIAL_Place *
1088 GNUNET_SOCIAL_guest_get_place (struct GNUNET_SOCIAL_Guest *guest);
1092 * A history request.
1094 struct GNUNET_SOCIAL_HistoryRequest;
1098 * Get the public key of a place.
1103 * @return Public key of the place.
1105 const struct GNUNET_CRYPTO_EddsaPublicKey *
1106 GNUNET_SOCIAL_place_get_pub_key (const struct GNUNET_SOCIAL_Place *plc);
1110 * Set message processing @a flags for a @a method_prefix.
1114 * @param method_prefix
1115 * Method prefix @a flags apply to.
1117 * The flags that apply to a matching @a method_prefix.
1120 GNUNET_SOCIAL_place_msg_proc_set (struct GNUNET_SOCIAL_Place *plc,
1121 const char *method_prefix,
1122 enum GNUNET_SOCIAL_MsgProcFlags flags);
1125 * Clear all message processing flags previously set for this place.
1128 GNUNET_SOCIAL_place_msg_proc_clear (struct GNUNET_SOCIAL_Place *plc);
1132 * Learn about the history of a place.
1134 * Messages are returned through the @a slicer function
1135 * and have the #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
1138 * Place we want to learn more about.
1139 * @param start_message_id
1140 * First historic message we are interested in.
1141 * @param end_message_id
1142 * Last historic message we are interested in (inclusive).
1143 * @param method_prefix
1144 * Only retrieve messages with this method prefix.
1146 * OR'ed GNUNET_PSYC_HistoryReplayFlags
1148 * Slicer to use for retrieved messages.
1149 * Can be the same as the slicer of the place.
1151 * Function called after all messages retrieved.
1152 * NULL if not needed.
1153 * @param cls Closure for @a result_cb.
1155 struct GNUNET_SOCIAL_HistoryRequest *
1156 GNUNET_SOCIAL_place_history_replay (struct GNUNET_SOCIAL_Place *plc,
1157 uint64_t start_message_id,
1158 uint64_t end_message_id,
1159 const char *method_prefix,
1161 struct GNUNET_PSYC_Slicer *slicer,
1162 GNUNET_ResultCallback result_cb,
1167 * Learn about the history of a place.
1169 * Sends messages through the slicer function of the place where
1170 * start_message_id <= message_id <= end_message_id.
1171 * The messages will have the #GNUNET_PSYC_MESSAGE_HISTORIC flag set.
1173 * To get the latest message, use 0 for both the start and end message ID.
1176 * Place we want to learn more about.
1177 * @param message_limit
1178 * Maximum number of historic messages we are interested in.
1180 * Function called after all messages retrieved.
1181 * NULL if not needed.
1182 * @param cls Closure for @a result_cb.
1184 struct GNUNET_SOCIAL_HistoryRequest *
1185 GNUNET_SOCIAL_place_history_replay_latest (struct GNUNET_SOCIAL_Place *plc,
1186 uint64_t message_limit,
1187 const char *method_prefix,
1189 struct GNUNET_PSYC_Slicer *slicer,
1190 GNUNET_ResultCallback result_cb,
1194 * Cancel learning about the history of a place.
1197 * History lesson to cancel.
1200 GNUNET_SOCIAL_place_history_replay_cancel (struct GNUNET_SOCIAL_HistoryRequest *hist);
1203 struct GNUNET_SOCIAL_LookHandle;
1207 * Look at a particular object in the place.
1209 * The best matching object is returned (its name might be less specific than
1210 * what was requested).
1213 * The place to look the object at.
1215 * Full name of the object.
1217 * @return NULL if there is no such object at this place.
1219 struct GNUNET_SOCIAL_LookHandle *
1220 GNUNET_SOCIAL_place_look_at (struct GNUNET_SOCIAL_Place *plc,
1221 const char *full_name,
1222 GNUNET_PSYC_StateVarCallback var_cb,
1223 GNUNET_ResultCallback result_cb,
1227 * Look for objects in the place with a matching name prefix.
1230 * The place to look its objects at.
1231 * @param name_prefix
1232 * Look at objects with names beginning with this value.
1234 * Function to call for each object found.
1236 * Closure for callback function.
1238 * @return Handle that can be used to stop looking at objects.
1240 struct GNUNET_SOCIAL_LookHandle *
1241 GNUNET_SOCIAL_place_look_for (struct GNUNET_SOCIAL_Place *plc,
1242 const char *name_prefix,
1243 GNUNET_PSYC_StateVarCallback var_cb,
1244 GNUNET_ResultCallback result_cb,
1249 * Stop looking at objects.
1251 * @param lh Look handle to stop.
1254 GNUNET_SOCIAL_place_look_cancel (struct GNUNET_SOCIAL_LookHandle *lh);
1258 * Advertise a @e place in the GNS zone of @a ego.
1261 * Application handle.
1264 * @param place_pub_key
1265 * Public key of place to add.
1267 * The name for the PLACE record to put in the zone.
1269 * Password used to encrypt the record or NULL to keep it cleartext.
1270 * @param relay_count
1271 * Number of elements in the @a relays array.
1273 * List of relays to put in the PLACE record to advertise
1274 * as entry points to the place in addition to the origin.
1275 * @param expiration_time
1276 * Expiration time of the record, use 0 to remove the record.
1278 * Function called with the result of the operation.
1280 * Closure for @a result_cb
1282 * @return #GNUNET_OK if the request was sent,
1283 * #GNUNET_SYSERR on error, e.g. the name/password is too long.
1286 GNUNET_SOCIAL_zone_add_place (const struct GNUNET_SOCIAL_App *app,
1287 const struct GNUNET_SOCIAL_Ego *ego,
1289 const char *password,
1290 const struct GNUNET_CRYPTO_EddsaPublicKey *place_pub_key,
1291 const struct GNUNET_PeerIdentity *origin,
1292 uint32_t relay_count,
1293 const struct GNUNET_PeerIdentity *relays,
1294 struct GNUNET_TIME_Absolute expiration_time,
1295 GNUNET_ResultCallback result_cb,
1300 * Add public key to the GNS zone of the @e ego.
1307 * The name for the PKEY record to put in the zone.
1308 * @param nym_pub_key
1309 * Public key of nym to add.
1310 * @param expiration_time
1311 * Expiration time of the record, use 0 to remove the record.
1313 * Function called with the result of the operation.
1315 * Closure for @a result_cb
1317 * @return #GNUNET_OK if the request was sent,
1318 * #GNUNET_SYSERR on error, e.g. the name is too long.
1321 GNUNET_SOCIAL_zone_add_nym (const struct GNUNET_SOCIAL_App *app,
1322 const struct GNUNET_SOCIAL_Ego *ego,
1324 const struct GNUNET_CRYPTO_EcdsaPublicKey *nym_pub_key,
1325 struct GNUNET_TIME_Absolute expiration_time,
1326 GNUNET_ResultCallback result_cb,
1330 #if 0 /* keep Emacsens' auto-indent happy */
1337 /* ifndef GNUNET_SOCIAL_SERVICE_H */
1340 /** @} */ /* end of group */