aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_conversation_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_conversation_service.h')
-rw-r--r--src/include/gnunet_conversation_service.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/include/gnunet_conversation_service.h b/src/include/gnunet_conversation_service.h
index cb84fcc67..3ef3c2f3d 100644
--- a/src/include/gnunet_conversation_service.h
+++ b/src/include/gnunet_conversation_service.h
@@ -1,17 +1,17 @@
1/* 1/*
2 This file is part of GNUnet 2 This file is part of GNUnet
3 (C) 2013 Christian Grothoff (and other contributing authors) 3 (C) 2013 Christian Grothoff (and other contributing authors)
4 4
5 GNUnet is free software; you can redistribute it and/or modify 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 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 7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version. 8 option) any later version.
9 9
10 GNUnet is distributed in the hope that it will be useful, but 10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of 11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details. 13 General Public License for more details.
14 14
15 You should have received a copy of the GNU General Public License 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 16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330, 17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
@@ -25,7 +25,7 @@
25 * @author Andreas Fuchs 25 * @author Andreas Fuchs
26 * @author Christian Grothoff 26 * @author Christian Grothoff
27 * 27 *
28 * 28 *
29 * NOTE: This API is deliberately deceptively simple; the idea 29 * NOTE: This API is deliberately deceptively simple; the idea
30 * is that advanced features (such as answering machines) will 30 * is that advanced features (such as answering machines) will
31 * be done with a separate service (an answering machine service) 31 * be done with a separate service (an answering machine service)
@@ -109,17 +109,17 @@ struct GNUNET_CONVERSATION_PhoneRecord
109enum GNUNET_CONVERSATION_EventCode 109enum GNUNET_CONVERSATION_EventCode
110{ 110{
111 /** 111 /**
112 * The phone is ringing, caller ID is provided in the varargs as 112 * The phone is ringing, caller ID is provided in the varargs as
113 * a `const char *`. The caller ID will be a GNS name. 113 * a `const char *`. The caller ID will be a GNS name.
114 */ 114 */
115 GNUNET_CONVERSATION_EC_RING, 115 GNUNET_CONVERSATION_EC_RING,
116 116
117 /** 117 /**
118 * We are the caller and are now ringing the other party. 118 * We are the caller and are now ringing the other party.
119 * The varargs will be empty. 119 * The varargs will be empty.
120 */ 120 */
121 GNUNET_CONVERSATION_EC_RINGING, 121 GNUNET_CONVERSATION_EC_RINGING,
122 122
123 /** 123 /**
124 * We are ready to talk, metadata about the call may be supplied 124 * We are ready to talk, metadata about the call may be supplied
125 * as a `const char *` in the varargs. 125 * as a `const char *` in the varargs.
@@ -139,7 +139,7 @@ enum GNUNET_CONVERSATION_EventCode
139 * client must no longer call #GNUNET_CONVERSATION_call_stop. 139 * client must no longer call #GNUNET_CONVERSATION_call_stop.
140 */ 140 */
141 GNUNET_CONVERSATION_EC_BUSY, 141 GNUNET_CONVERSATION_EC_BUSY,
142 142
143 /** 143 /**
144 * The conversation was terminated, a reason may be supplied as a 144 * The conversation was terminated, a reason may be supplied as a
145 * `const char *` in the varargs. After this invocation, the 145 * `const char *` in the varargs. After this invocation, the
@@ -147,7 +147,7 @@ enum GNUNET_CONVERSATION_EventCode
147 * client must no longer call #GNUNET_CONVERSATION_call_stop. 147 * client must no longer call #GNUNET_CONVERSATION_call_stop.
148 */ 148 */
149 GNUNET_CONVERSATION_EC_TERMINATED 149 GNUNET_CONVERSATION_EC_TERMINATED
150 150
151}; 151};
152 152
153 153
@@ -207,7 +207,7 @@ GNUNET_CONVERSATION_phone_get_record (struct GNUNET_CONVERSATION_Phone *phone,
207 207
208 208
209/** 209/**
210 * Picks up a (ringing) phone. This will connect the speaker 210 * Picks up a (ringing) phone. This will connect the speaker
211 * to the microphone of the other party, and vice versa. 211 * to the microphone of the other party, and vice versa.
212 * 212 *
213 * @param phone phone to pick up 213 * @param phone phone to pick up