/*
This file is part of GNUnet
(C) 2013 Christian Grothoff (and other contributing authors)
-
+
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
-
+
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
-
+
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* @author Andreas Fuchs
* @author Christian Grothoff
*
- *
+ *
* 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)
enum GNUNET_CONVERSATION_EventCode
{
/**
- * The phone is ringing, caller ID is provided in the varargs as
+ * 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 the caller and are now ringing the other party.
+ * We are the caller and are now ringing the other party.
* The varargs will be empty.
*/
GNUNET_CONVERSATION_EC_RINGING,
-
+
/**
* We are ready to talk, metadata about the call may be supplied
* as a `const char *` in the varargs.
GNUNET_CONVERSATION_EC_READY,
/**
- * We failed to locate a phone record in GNS.
+ * We failed to locate a phone record in GNS. After this invocation,
+ * the respective call handle will be automatically destroyed and the
+ * client must no longer call #GNUNET_CONVERSATION_call_stop.
*/
GNUNET_CONVERSATION_EC_GNS_FAIL,
/**
- * The phone is busy. Varargs will be empty.
+ * The phone is busy. Varargs will be empty. After this invocation,
+ * the respective call handle will be automatically destroyed and the
+ * client must no longer call #GNUNET_CONVERSATION_call_stop.
*/
GNUNET_CONVERSATION_EC_BUSY,
-
+
/**
- * The conversation was terminated, a reason may be supplied
- * as a `const char *` in the varargs.
+ * The conversation was terminated, a reason may be supplied as a
+ * `const char *` in the varargs. After this invocation, the
+ * respective call handle will be automatically destroyed and the
+ * client must no longer call #GNUNET_CONVERSATION_call_stop.
*/
GNUNET_CONVERSATION_EC_TERMINATED
-
+
};
/**
- * Picks up a (ringing) phone. This will connect the speaker
+ * 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