[GNUnet-SVN] r29796 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2013-10-02 20:28:36 +0200 (Wed, 02 Oct 2013)
New Revision: 29796

Modified:
   gnunet/src/include/gnunet_conversation_service.h
Log:
-proposing improved conversation API

Modified: gnunet/src/include/gnunet_conversation_service.h
===================================================================
--- gnunet/src/include/gnunet_conversation_service.h    2013-10-02 17:10:22 UTC 
(rev 29795)
+++ gnunet/src/include/gnunet_conversation_service.h    2013-10-02 18:28:36 UTC 
(rev 29796)
@@ -23,6 +23,7 @@
  * @brief API to the conversation service
  * @author Simon Dieterle
  * @author Andreas Fuchs
+ * @author Christian Grothoff
  */
 #ifndef GNUNET_CONVERSATION_SERVICE_H
 #define GNUNET_CONVERSATION_SERVICE_H
@@ -206,6 +207,248 @@
 GNUNET_CONVERSATION_reject (struct GNUNET_CONVERSATION_Handle *handle);
 
 
+
+////////////////////////////////////////////////////////////////////
+////////////////////////// NEW API /////////////////////////////////
+////////////////////////////////////////////////////////////////////
+
+/* 
+   NOTE: This API is deliberately deceptively simple; the idea
+   is that advanced features (such as answering machines) will
+   be done with a separate service (an answering machine service)
+   with its own APIs; the speaker/microphone abstractions are
+   used to facilitate plugging in custom logic for implementing
+   such a service later by creating "software" versions of
+   speakers and microphones that record to disk or play a file.
+   Notifications about missed calls should similarly be done
+   using a separate service; CONVERSATION is supposed to be just
+   the "bare bones" voice service.
+
+   Meta data passing is supported so that advanced services
+   can identify themselves appropriately.
+
+   As this is supposed to be a "secure" service, caller ID is of
+   course provided as part of the basic implementation, as only the
+   CONVERSATION service can know for sure who it is that we are
+   talking to.x */
+
+
+#include "gnunet_identity_service.h"
+#include "gnunet_namestore_service.h"
+
+
+/**
+ * A speaker is a device that can play or record audio data.
+ */
+struct GNUNET_CONVERSATION_Speaker;
+
+
+/**
+ * Create a speaker that corresponds to the speaker hardware
+ * of our system.
+ *
+ * @param cfg configuration to use
+ * @return NULL on error
+ */
+struct GNUNET_CONVERSATION_Speaker *
+GNUNET_CONVERSATION_speaker_create_from_hardware (struct 
GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Destroy a speaker.
+ *
+ * @param speaker speaker to destroy
+ */
+void
+GNUNET_CONVERSATION_speaker_destroy (struct GNUNET_CONVERSATION_Speaker 
*speaker);
+
+
+/**
+ * A speaker is a device that can generate audio data.
+ */
+struct GNUNET_CONVERSATION_Microphone;
+
+
+/**
+ * Create a speaker that corresponds to the speaker hardware
+ * of our system.
+ *
+ * @param cfg configuration to use
+ * @return NULL on error
+ */
+struct GNUNET_CONVERSATION_Microphone *
+GNUNET_CONVERSATION_microphone_create_from_hardware (struct 
GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Destroy a microphone.
+ *
+ * @param mic microphone to destroy
+ */
+void
+GNUNET_CONVERSATION_microphone_destroy (struct GNUNET_CONVERSATION_Microphone 
*mic);
+
+
+/**
+ * Information about the current status of a call.  Each call
+ * progresses from ring over ready to terminated.  Steps may
+ * be skipped.
+ */
+enum GNUNET_CONVERSATION_EventCode
+{
+  /**
+   * The phone is ringing, caller ID is provided in the varargs as 
+   * a `const char *`.  The caller ID will be a GNS name.
+   */
+  GNUNET_CONVERSATION_EC_RING,
+  
+  /**
+   * We are ready to talk, metadata about the call may be supplied
+   * as a `const char *` in the varargs.
+   */
+  GNUNET_CONVERSATION_EC_READY,
+  
+  /**
+   * The conversation was terminated, a reason may be supplied
+   * as a `const char *` in the varargs.
+   */
+  GNUNET_CONVERSATION_EC_TERMINATED
+  
+};
+
+
+/**
+ * Function called with an event emitted by a phone.
+ *
+ * @param cls closure
+ * @param code type of the event on the phone
+ * @param ... additional information, depends on @a code
+ */
+typedef void (*GNUNET_CONVERSATION_EventHandler)(void *cls,
+                                                enum 
GNUNET_CONVERSATION_EventCode code,
+                                                ...);
+
+
+/**
+ * A phone is a device that can ring to signal an incoming call and
+ * that you can pick up to answer the call and hang up to terminate
+ * the call.  You can also hang up a ringing phone immediately
+ * (without picking it up) to stop it from ringing.  Phones have
+ * caller ID.  You can ask the phone for its record and make that
+ * record available (via GNS) to enable others to call you.
+ * Multiple phones maybe connected to the same line (the line is
+ * something rather internal to a phone and not obvious from it).
+ * You can only have one conversation per phone at any time.
+ */
+struct GNUNET_CONVERSATION_Phone;
+
+
+/**
+ * Create a new phone.
+ *
+ * @param cfg configuration for the phone; specifies the phone service and
+ *        which line the phone is to be connected to
+ * @param event_handler how to notify the owner of the phone about events
+ * @param event_handler_cls closure for @a event_handler
+ */
+struct GNUNET_CONVERSATION_Phone *
+GNUNET_CONVERSATION_phone_create (const struct GNUNET_CONFIGURATION_Handle 
*cfg,
+                                 GNUNET_CONVERSATION_EventHandler 
event_handler,
+                                 void *event_handler_cls);
+
+
+/**
+ * Fill in a namestore record with the contact information
+ * for this phone.  Note that the filled in "data" value
+ * is only valid until the phone is destroyed.
+ *
+ * @param phone phone to create a record for
+ * @param rd namestore record to fill in
+ */
+void
+GNUNET_CONVERSATION_phone_get_record (struct GNUNET_CONVERSATION_Phone *phone,
+                                     struct GNUNET_NAMESTORE_RecordData *rd);
+
+
+/**
+ * Picks up a (ringing) phone.  This will connect the speaker 
+ * to the microphone of the other party, and vice versa.
+ *
+ * @param phone phone to pick up
+ * @param metadata meta data to give to the other user about the pick up event
+ * @param speaker speaker to use
+ * @param mic microphone to use
+ */
+void
+GNUNET_CONVERSTATION_phone_pick_up (struct GNUNET_CONVERSATION_Phone *phone,
+                                   const char *metadata,
+                                   struct GNUNET_CONVERSATION_Speaker *speaker,
+                                   struct GNUNET_CONVERSATION_Microphone *mic);
+
+
+/**
+ * Hang up up a (possibly ringing) phone.  This will notify the other
+ * party that we are no longer interested in talking with them.
+ *
+ * @param phone phone to pick up
+ * @param reason text we give to the other party about why we terminated the 
conversation
+ */
+void
+GNUNET_CONVERSTATION_phone_hang_up (struct GNUNET_CONVERSATION_Phone *phone,
+                                   const char *reason);
+
+
+/**
+ * Destroys a phone.
+ *
+ * @param phone phone to destroy
+ */
+void
+GNUNET_CONVERSATION_phone_destroy (struct GNUNET_CONVERSATION_Phone *phone);
+
+
+/**
+ * Handle for an outgoing call.
+ */
+struct GNUNET_CONVERSATION_Call;
+
+
+/**
+ * Call the phone of another user.
+ *
+ * @param cfg configuration to use, specifies our phone service
+ * @param caller_id identity of the caller
+ * @param callee GNS name of the callee (used to locate the callee's record)
+ * @param speaker speaker to use (will be used automatically immediately once 
the
+ *        #GNUNET_CONVERSATION_EC_READY event is generated); we will NOT 
generate
+ *        a ring tone on the speaker
+ * @param mic microphone to use (will be used automatically immediately once 
the
+ *        #GNUNET_CONVERSATION_EC_READY event is generated)
+ * @param event_handler how to notify the owner of the phone about events
+ * @param event_handler_cls closure for @a event_handler
+ */
+struct GNUNET_CONVERSATION_Call *
+GNUNET_CONVERSATION_call_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                               struct GNUNET_IDENTITY_Ego *caller_id,
+                               const char *callee,
+                               struct GNUNET_CONVERSATION_Speaker *speaker,
+                               struct GNUNET_CONVERSATION_Microphone *mic,
+                               GNUNET_CONVERSATION_EventHandler event_handler,
+                               void *event_handler_cls);
+
+
+/**
+ * Terminate a call.  The call may be ringing or ready at this time.
+ *
+ * @param call call to terminate
+ * @param reason if the call was active (ringing or ready) this will be the
+ *        reason given to the other user for why we hung up
+ */
+struct GNUNET_CONVERSATION_Call *
+GNUNET_CONVERSATION_call_stop (const struct GNUNET_CONVERSATION_Call *call,
+                              const char *reason);
+
+
 #if 0                          /* keep Emacsens' auto-indent happy */
 {
 #endif