2 This file is part of GNUnet
3 Copyright (C) 2013, 2014 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 Simon Dieterle
23 * @author Andreas Fuchs
24 * @author Christian Grothoff
27 * API to the conversation service
29 * @defgroup conversation Conversation service
30 * One-to-one voice communication over CADET
32 * NOTE: This API is deliberately deceptively simple; the idea
33 * is that advanced features (such as answering machines) will
34 * be done with a separate service (an answering machine service)
35 * with its own APIs; the speaker/microphone abstractions are
36 * used to facilitate plugging in custom logic for implementing
37 * such a service later by creating "software" versions of
38 * speakers and microphones that record to disk or play a file.
39 * Notifications about missed calls should similarly be done
40 * using a separate service; CONVERSATION is supposed to be just
41 * the "bare bones" voice service.
43 * As this is supposed to be a "secure" service, caller ID is of
44 * course provided as part of the basic implementation, as only the
45 * CONVERSATION service can know for sure who it is that we are
50 #ifndef GNUNET_CONVERSATION_SERVICE_H
51 #define GNUNET_CONVERSATION_SERVICE_H
56 #if 0 /* keep Emacsens' auto-indent happy */
61 #include "gnunet_util_lib.h"
62 #include "gnunet_identity_service.h"
63 #include "gnunet_namestore_service.h"
64 #include "gnunet_speaker_lib.h"
65 #include "gnunet_microphone_lib.h"
69 * Version of the conversation API.
71 #define GNUNET_CONVERSATION_VERSION 0x00000003
74 * Handle to identify a particular caller. A caller is an entity that
75 * initiate a call to a phone. This struct identifies the caller to
76 * the user operating the phone. The entity that initiated the call
77 * will have a `struct GNUNET_CONVERSATION_Call`.
79 struct GNUNET_CONVERSATION_Caller;
82 GNUNET_NETWORK_STRUCT_BEGIN
85 * A phone record specifies which peer is hosting a given user and
86 * may also specify the phone line that is used (typically zero).
87 * The version is also right now always zero.
89 struct GNUNET_CONVERSATION_PhoneRecord
93 * Version of the phone record, for now always zero. We may
94 * use other versions for anonymously hosted phone lines in
97 uint32_t version GNUNET_PACKED;
100 * Phone line to use at the peer.
102 uint32_t line GNUNET_PACKED;
105 * Identity of the peer hosting the phone service.
107 struct GNUNET_PeerIdentity peer;
111 GNUNET_NETWORK_STRUCT_END
114 * Information about active callers to a phone.
116 enum GNUNET_CONVERSATION_PhoneEventCode
119 * We are the callee and the phone is ringing.
120 * We should accept the call or hang up.
122 GNUNET_CONVERSATION_EC_PHONE_RING,
125 * The conversation was terminated by the caller.
126 * We must no longer use the caller's handle.
128 GNUNET_CONVERSATION_EC_PHONE_HUNG_UP
134 * Function called with an event emitted by a phone.
137 * @param code type of the event
138 * @param caller handle for the caller
139 * @param caller_id public key of the caller (in GNS)
142 (*GNUNET_CONVERSATION_PhoneEventHandler)(void *cls,
143 enum GNUNET_CONVERSATION_PhoneEventCode code,
144 struct GNUNET_CONVERSATION_Caller *caller,
145 const struct GNUNET_CRYPTO_EcdsaPublicKey *caller_id);
149 * Information about the current status of a call. Each call
150 * progresses from ring over ready to terminated. Steps may
153 enum GNUNET_CONVERSATION_CallerEventCode
157 * We are the callee and the caller suspended the call. Note that
158 * both sides can independently suspend and resume calls; a call is
159 * only "working" of both sides are active.
161 GNUNET_CONVERSATION_EC_CALLER_SUSPEND,
164 * We are the callee and the caller resumed the call. Note that
165 * both sides can independently suspend and resume calls; a call is
166 * only "working" of both sides are active.
168 GNUNET_CONVERSATION_EC_CALLER_RESUME
174 * Function called with an event emitted by a caller.
175 * These events are only generated after the phone is
179 * @param code type of the event for this caller
182 (*GNUNET_CONVERSATION_CallerEventHandler)(void *cls,
183 enum GNUNET_CONVERSATION_CallerEventCode code);
187 * A phone is a device that can ring to signal an incoming call and
188 * that you can pick up to answer the call and hang up to terminate
189 * the call. You can also hang up a ringing phone immediately
190 * (without picking it up) to stop it from ringing. Phones have
191 * caller ID. You can ask the phone for its record and make that
192 * record available (via GNS) to enable others to call you.
193 * Multiple phones maybe connected to the same line (the line is
194 * something rather internal to a phone and not obvious from it).
195 * You can only have one conversation per phone at any time.
197 struct GNUNET_CONVERSATION_Phone;
201 * Create a new phone.
203 * @param cfg configuration for the phone; specifies the phone service and
204 * which line the phone is to be connected to
205 * @param ego ego to use for name resolution (when determining caller ID)
206 * @param event_handler how to notify the owner of the phone about events
207 * @param event_handler_cls closure for @a event_handler
209 struct GNUNET_CONVERSATION_Phone *
210 GNUNET_CONVERSATION_phone_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
211 const struct GNUNET_IDENTITY_Ego *ego,
212 GNUNET_CONVERSATION_PhoneEventHandler event_handler,
213 void *event_handler_cls);
217 * Fill in a namestore record with the contact information
218 * for this phone. Note that the filled in "data" value
219 * is only valid until the phone is destroyed.
221 * @param phone phone to create a record for
222 * @param rd namestore record to fill in
225 GNUNET_CONVERSATION_phone_get_record (struct GNUNET_CONVERSATION_Phone *phone,
226 struct GNUNET_GNSRECORD_Data *rd);
230 * Picks up a (ringing) phone call. This will connect the speaker
231 * to the microphone of the other party, and vice versa.
233 * @param caller handle that identifies which caller should be answered
234 * @param event_handler how to notify about events by the caller
235 * @param event_handler_cls closure for @a event_handler
236 * @param speaker speaker to use
237 * @param mic microphone to use
240 GNUNET_CONVERSATION_caller_pick_up (struct GNUNET_CONVERSATION_Caller *caller,
241 GNUNET_CONVERSATION_CallerEventHandler event_handler,
242 void *event_handler_cls,
243 struct GNUNET_SPEAKER_Handle *speaker,
244 struct GNUNET_MICROPHONE_Handle *mic);
248 * Pause conversation of an active call. This will disconnect the speaker
249 * and the microphone. The call can later be resumed with
250 * #GNUNET_CONVERSATION_caller_resume.
252 * @param caller call to suspend
255 GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller);
259 * Resume suspended conversation of a phone.
261 * @param caller call to resume
262 * @param speaker speaker to use
263 * @param mic microphone to use
266 GNUNET_CONVERSATION_caller_resume (struct GNUNET_CONVERSATION_Caller *caller,
267 struct GNUNET_SPEAKER_Handle *speaker,
268 struct GNUNET_MICROPHONE_Handle *mic);
272 * Hang up up a (possibly ringing or paused) phone. This will notify
273 * the caller that we are no longer interested in talking with them.
275 * @param caller who should we hang up on
278 GNUNET_CONVERSATION_caller_hang_up (struct GNUNET_CONVERSATION_Caller *caller);
284 * @param phone phone to destroy
287 GNUNET_CONVERSATION_phone_destroy (struct GNUNET_CONVERSATION_Phone *phone);
290 /* *********************** CALL API ************************ */
293 * Handle for an outgoing call.
295 struct GNUNET_CONVERSATION_Call;
299 * Information about the current status of a call.
301 enum GNUNET_CONVERSATION_CallEventCode
305 * We are the caller and are now ringing the other party (GNS lookup
308 GNUNET_CONVERSATION_EC_CALL_RINGING,
311 * We are the caller and are now ready to talk as the callee picked up.
313 GNUNET_CONVERSATION_EC_CALL_PICKED_UP,
316 * We are the caller and failed to locate a phone record in GNS.
317 * After this invocation, the respective call handle will be
318 * automatically destroyed and the client must no longer call
319 * #GNUNET_CONVERSATION_call_stop or any other function on the
322 GNUNET_CONVERSATION_EC_CALL_GNS_FAIL,
325 * We are the caller and the callee called
326 * #GNUNET_CONVERSATION_caller_hang_up. After this invocation, the
327 * respective call handle will be automatically destroyed and the
328 * client must no longer call #GNUNET_CONVERSATION_call_stop.
330 GNUNET_CONVERSATION_EC_CALL_HUNG_UP,
333 * We are the caller and the callee suspended the call. Note that
334 * both sides can independently suspend and resume calls; a call is
335 * only "working" of both sides are active.
337 GNUNET_CONVERSATION_EC_CALL_SUSPENDED,
340 * We are the caller and the callee suspended the call. Note that
341 * both sides can independently suspend and resume calls; a call is
342 * only "working" of both sides are active.
344 GNUNET_CONVERSATION_EC_CALL_RESUMED,
347 * We had an error handing the call, and are now restarting it
348 * (back to lookup). This happens, for example, if the peer
349 * is restarted during a call.
351 GNUNET_CONVERSATION_EC_CALL_ERROR
357 * Function called with an event emitted for a call.
360 * @param code type of the event on the call
363 (*GNUNET_CONVERSATION_CallEventHandler)(void *cls,
364 enum GNUNET_CONVERSATION_CallEventCode code);
368 * Call the phone of another user.
370 * @param cfg configuration to use, specifies our phone service
371 * @param caller_id identity of the caller
372 * @param zone_id GNS zone to use to resolve @a callee
373 * @param callee GNS name of the callee (used to locate the callee's record)
374 * @param speaker speaker to use (will be used automatically immediately once the
375 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated); we will NOT generate
376 * a ring tone on the speaker
377 * @param mic microphone to use (will be used automatically immediately once the
378 * #GNUNET_CONVERSATION_EC_CALL_PICKED_UP event is generated)
379 * @param event_handler how to notify the owner of the phone about events
380 * @param event_handler_cls closure for @a event_handler
381 * @return handle for the call
383 struct GNUNET_CONVERSATION_Call *
384 GNUNET_CONVERSATION_call_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
385 struct GNUNET_IDENTITY_Ego *caller_id,
386 struct GNUNET_IDENTITY_Ego *zone_id,
388 struct GNUNET_SPEAKER_Handle *speaker,
389 struct GNUNET_MICROPHONE_Handle *mic,
390 GNUNET_CONVERSATION_CallEventHandler event_handler,
391 void *event_handler_cls);
395 * Pause a call. Temporarily suspends the use of speaker and
398 * @param call call to pause
401 GNUNET_CONVERSATION_call_suspend (struct GNUNET_CONVERSATION_Call *call);
405 * Resumes a call after #GNUNET_CONVERSATION_call_suspend.
407 * @param call call to resume
408 * @param speaker speaker to use
409 * @param mic microphone to use
412 GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
413 struct GNUNET_SPEAKER_Handle *speaker,
414 struct GNUNET_MICROPHONE_Handle *mic);
418 * Terminate a call. The call may be ringing or ready at this time.
420 * @param call call to terminate
423 GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call);
426 #if 0 /* keep Emacsens' auto-indent happy */
435 /** @} */ /* end of group */