GNUnet  0.10.x
gnunet_conversation_service.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2013, 2014, 2016 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
50 #ifndef GNUNET_CONVERSATION_SERVICE_H
51 #define GNUNET_CONVERSATION_SERVICE_H
52 
53 #ifdef __cplusplus
54 extern "C"
55 {
56 #if 0 /* keep Emacsens' auto-indent happy */
57 }
58 #endif
59 #endif
60 
61 #include "gnunet_util_lib.h"
64 #include "gnunet_speaker_lib.h"
65 #include "gnunet_microphone_lib.h"
66 
67 
71 #define GNUNET_CONVERSATION_VERSION 0x00000004
72 
80 
81 
83 
90 {
91 
98 
103 
108 
113 
114 };
115 
117 
122 {
128 
134 
135 };
136 
137 
146 typedef void
149  struct GNUNET_CONVERSATION_Caller *caller,
150  const struct GNUNET_CRYPTO_EcdsaPublicKey *caller_id);
151 
152 
159 {
160 
167 
174 
175 };
176 
177 
186 typedef void
189 
190 
203 
204 
216  const struct GNUNET_IDENTITY_Ego *ego,
218  void *event_handler_cls);
219 
220 
229 void
231  struct GNUNET_GNSRECORD_Data *rd);
232 
233 
244 void
247  void *event_handler_cls,
249  struct GNUNET_MICROPHONE_Handle *mic);
250 
251 
259 void
261 
262 
270 void
273  struct GNUNET_MICROPHONE_Handle *mic);
274 
275 
282 void
284 
285 
291 void
293 
294 
295 /* *********************** CALL API ************************ */
296 
301 
302 
307 {
308 
314 
319 
328 
336 
343 
350 
357 
358 };
359 
360 
367 typedef void
370 
371 
390  const char *callee,
394  void *event_handler_cls);
395 
396 
403 void
405 
406 
414 void
417  struct GNUNET_MICROPHONE_Handle *mic);
418 
419 
425 void
427 
428 
429 #if 0 /* keep Emacsens' auto-indent happy */
430 {
431 #endif
432 #ifdef __cplusplus
433 }
434 #endif
435 
436 #endif
437  /* end of group */
void(* GNUNET_CONVERSATION_CallEventHandler)(void *cls, enum GNUNET_CONVERSATION_CallEventCode code)
Function called with an event emitted for a call.
struct GNUNET_PeerIdentity peer
Identity of the peer hosting the phone service.
static struct GNUNET_CONVERSATION_Phone * phone
Phone handle.
GNUNET_CONVERSATION_PhoneEventHandler event_handler
Function to call for phone events.
We are the caller and the callee suspended the call.
void GNUNET_CONVERSATION_caller_hang_up(struct GNUNET_CONVERSATION_Caller *caller)
Hang up up a (possibly ringing or paused) phone.
We are the callee and the caller resumed the call.
struct GNUNET_IDENTITY_Ego * caller_id
Our caller identity.
void GNUNET_CONVERSATION_phone_get_record(struct GNUNET_CONVERSATION_Phone *phone, struct GNUNET_GNSRECORD_Data *rd)
Fill in a namestore record with the contact information for this phone.
#define GNUNET_NETWORK_STRUCT_BEGIN
Define as empty, GNUNET_PACKED should suffice, but this won&#39;t work on W32.
static struct GNUNET_MICROPHONE_Handle * mic
Our microphone.
We are the caller and are now ready to talk as the callee picked up.
A phone is a device that can ring to signal an incoming call and that you can pick up to answer the c...
A phone record specifies which peer is hosting a given user and may also specify the phone line that ...
Handle for an ego.
Definition: identity.h:245
void * event_handler_cls
Closure for event_handler.
void * event_handler_cls
Closure for event_handler.
char * callee
Target callee as a GNS address/name.
void GNUNET_CONVERSATION_call_resume(struct GNUNET_CONVERSATION_Call *call, struct GNUNET_SPEAKER_Handle *speaker, struct GNUNET_MICROPHONE_Handle *mic)
Resumes a call after GNUNET_CONVERSATION_call_suspend.
void GNUNET_CONVERSATION_phone_destroy(struct GNUNET_CONVERSATION_Phone *phone)
Destroys a phone.
We are the caller and are now ringing the other party (GNS lookup succeeded).
We are the caller and the callee called GNUNET_CONVERSATION_caller_hang_up.
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_SPEAKER_Handle *speaker, struct GNUNET_MICROPHONE_Handle *mic, GNUNET_CONVERSATION_CallEventHandler event_handler, void *event_handler_cls)
Call the phone of another user.
A 512-bit hashcode.
A caller is the handle we have for an incoming call.
The conversation was terminated by the caller.
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
void GNUNET_CONVERSATION_caller_pick_up(struct GNUNET_CONVERSATION_Caller *caller, GNUNET_CONVERSATION_CallerEventHandler event_handler, void *event_handler_cls, struct GNUNET_SPEAKER_Handle *speaker, struct GNUNET_MICROPHONE_Handle *mic)
Picks up a (ringing) phone call.
We are the caller and failed to locate a phone record in GNS.
GNUNET_CONVERSATION_CallerEventCode
Information about the current status of a call.
void(* GNUNET_CONVERSATION_PhoneEventHandler)(void *cls, enum GNUNET_CONVERSATION_PhoneEventCode code, struct GNUNET_CONVERSATION_Caller *caller, const struct GNUNET_CRYPTO_EcdsaPublicKey *caller_id)
Function called with an event emitted by a phone.
uint32_t version
Version of the phone record, for now always one.
void GNUNET_CONVERSATION_caller_resume(struct GNUNET_CONVERSATION_Caller *caller, struct GNUNET_SPEAKER_Handle *speaker, struct GNUNET_MICROPHONE_Handle *mic)
Resume suspended conversation of a phone.
We are the callee and the caller suspended the call.
#define GNUNET_NETWORK_STRUCT_END
Define as empty, GNUNET_PACKED should suffice, but this won&#39;t work on W32;.
static struct GNUNET_CONVERSATION_Call * call
Call handle (for active outgoing call).
The identity of the host (wraps the signing key of the peer).
void GNUNET_CONVERSATION_caller_suspend(struct GNUNET_CONVERSATION_Caller *caller)
Pause conversation of an active call.
#define GNUNET_PACKED
gcc-ism to get packed structs.
configuration data
Definition: configuration.c:85
struct GNUNET_CONVERSATION_Phone * GNUNET_CONVERSATION_phone_create(const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_IDENTITY_Ego *ego, GNUNET_CONVERSATION_PhoneEventHandler event_handler, void *event_handler_cls)
Create a new phone.
Public ECC key (always for Curve25519) encoded in a format suitable for network transmission and ECDS...
We are the callee and the phone is ringing.
struct GNUNET_HashCode line_port
Phone line (CADET port) to connect to.
void GNUNET_CONVERSATION_call_stop(struct GNUNET_CONVERSATION_Call *call)
Terminate a call.
We are the caller and the callee suspended the call.
GNUNET_CONVERSATION_CallEventHandler event_handler
Function to call with events.
Handle for an outgoing call.
GNUNET_CONVERSATION_CallEventCode
Information about the current status of a call.
A microphone is a device that can capture or otherwise produce audio data.
We had an error handing the call, and are now restarting it (back to lookup).
A speaker is a device that can play or record audio data.
void GNUNET_CONVERSATION_call_suspend(struct GNUNET_CONVERSATION_Call *call)
Pause a call.
GNUNET_CONVERSATION_PhoneEventCode
Information about active callers to a phone.
static struct GNUNET_SPEAKER_Handle * speaker
Handle to the speaker.
void(* GNUNET_CONVERSATION_CallerEventHandler)(void *cls, enum GNUNET_CONVERSATION_CallerEventCode code)
Function called with an event emitted by a caller.