diff options
| -rw-r--r-- | src/include/gnunet_conversation_service.h | 226 | ||||
| -rw-r--r-- | src/include/gnunet_protocols.h | 109 |
2 files changed, 28 insertions, 307 deletions
diff --git a/src/include/gnunet_conversation_service.h b/src/include/gnunet_conversation_service.h index 248a663254..3c31127454 100644 --- a/src/include/gnunet_conversation_service.h +++ b/src/include/gnunet_conversation_service.h @@ -25,6 +25,26 @@ * @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) + * 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. + * * TODO: * - call waiting * - put on hold @@ -41,206 +61,6 @@ extern "C" #endif #include "gnunet_util_lib.h" - -/** - * Version of the conversation API. - */ -#define GNUNET_CONVERSATION_VERSION 0x00000001 - - -enum GNUNET_CONVERSATION_RejectReason -{ - GNUNET_CONVERSATION_REJECT_REASON_GENERIC = 0, - GNUNET_CONVERSATION_REJECT_REASON_NOT_AVAILABLE, - GNUNET_CONVERSATION_REJECT_REASON_NO_CLIENT, - GNUNET_CONVERSATION_REJECT_REASON_ACTIVE_CALL, - GNUNET_CONVERSATION_REJECT_REASON_NOT_WANTED, - GNUNET_CONVERSATION_REJECT_REASON_NO_ANSWER - -}; - - -enum GNUNET_CONVERSATION_NotificationType -{ - GNUNET_CONVERSATION_NT_SERVICE_BLOCKED = 0, - GNUNET_CONVERSATION_NT_NO_PEER, - GNUNET_CONVERSATION_NT_NO_ANSWER, - GNUNET_CONVERSATION_NT_AVAILABLE_AGAIN, - GNUNET_CONVERSATION_NT_CALL_ACCEPTED, - GNUNET_CONVERSATION_NT_CALL_TERMINATED -}; - - -/** - * - */ -struct GNUNET_CONVERSATION_MissedCall -{ - struct GNUNET_PeerIdentity peer; - struct GNUNET_TIME_Absolute time; -}; - - -struct GNUNET_CONVERSATION_MissedCallNotification -{ - int number; - struct GNUNET_CONVERSATION_MissedCall *calls; -}; - -struct GNUNET_CONVERSATION_CallInformation; - -struct GNUNET_CONVERSATION_Handle; - - -/** - * Method called whenever a call is incoming - * - * @param cls closure - * @param handle to the conversation session - * @param caller peer that calls you - */ -typedef void (GNUNET_CONVERSATION_CallHandler) (void *cls, - struct GNUNET_CONVERSATION_Handle *handle, - const struct GNUNET_PeerIdentity *caller); - - -/** - * Method called whenever a call is rejected - * - * @param cls closure - * @param handle to the conversation session - * @param reason reason given for rejecting the call - * @param peer peer that rejected your call - */ -typedef void (GNUNET_CONVERSATION_RejectHandler) (void *cls, - struct GNUNET_CONVERSATION_Handle *handle, - enum GNUNET_CONVERSATION_RejectReason reason, - const struct GNUNET_PeerIdentity *peer); - - -/** - * Method called whenever a notification is there - * - * @param cls closure - * @param handle to the conversation session - * @param type the type of the notification - * @param peer peer that the notification is about - */ -typedef void (GNUNET_CONVERSATION_NotificationHandler) (void *cls, - struct GNUNET_CONVERSATION_Handle *handle, - enum GNUNET_CONVERSATION_NotificationType type, - const struct GNUNET_PeerIdentity *peer); - - -/** - * Method called whenever a notification for missed calls is there - * - * @param cls closure - * @param handle to the conversation session - * @param missed_calls a list of missed calls - */ -typedef void (GNUNET_CONVERSATION_MissedCallHandler) (void *cls, - struct GNUNET_CONVERSATION_Handle *handle, - struct GNUNET_CONVERSATION_MissedCallNotification *missed_calls); - - -/** - * Connect to the VoIP service - * - * @param cfg configuration - * @param cls NULL - * @param call_handler the callback which is called when a call is incoming - * @param reject_handler the callback which is called when a call is rejected - * @param notification_handler the callback which is called when there is a notification - * @param missed_call_handler the callback which is called when the service notifies the client about missed clients - * @return handle to the connection to the conversation service - */ -struct GNUNET_CONVERSATION_Handle * -GNUNET_CONVERSATION_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, - void *cls, - GNUNET_CONVERSATION_CallHandler call_handler, - GNUNET_CONVERSATION_RejectHandler reject_handler, - GNUNET_CONVERSATION_NotificationHandler notification_handler, - GNUNET_CONVERSATION_MissedCallHandler missed_call_handler); - - -/** - * Disconnect from the VoIP service - * - * @param handle handle to the VoIP connection - */ -void -GNUNET_CONVERSATION_disconnect (struct GNUNET_CONVERSATION_Handle *handle); - - -/** - * Establish a call - * - * @param handle handle to the VoIP connection - * @param callee the peer (PeerIdentity or GNS name) to call - * @param doGnsLookup 0 = no GNS lookup or 1 = GNS lookup - */ -void -GNUNET_CONVERSATION_call (struct GNUNET_CONVERSATION_Handle *handle, - const char *callee, - int doGnsLookup); - - -/** - * Terminate the active call - * - * @param handle handle to the VoIP connection - */ -void -GNUNET_CONVERSATION_hangup (struct GNUNET_CONVERSATION_Handle *handle); - - -/** - * Accept an incoming call - * - * @param handle handle to the VoIP connection - */ -void -GNUNET_CONVERSATION_accept (struct GNUNET_CONVERSATION_Handle *handle); - - -/** - * Reject an incoming call - * - * @param handle handle to the VoIP connection - */ -void -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. - */ - - -#include "gnunet_util_lib.h" #include "gnunet_identity_service.h" #include "gnunet_namestore_service.h" #include "gnunet_speaker_lib.h" @@ -248,6 +68,12 @@ GNUNET_CONVERSATION_reject (struct GNUNET_CONVERSATION_Handle *handle); /** + * Version of the conversation API. + */ +#define GNUNET_CONVERSATION_VERSION 0x00000002 + + +/** * Information about the current status of a call. Each call * progresses from ring over ready to terminated. Steps may * be skipped. diff --git a/src/include/gnunet_protocols.h b/src/include/gnunet_protocols.h index 4d07c7712c..5380e0987f 100644 --- a/src/include/gnunet_protocols.h +++ b/src/include/gnunet_protocols.h @@ -2122,114 +2122,9 @@ extern "C" ******************************************************************************/ /** - * Client <-> Server message to initiate a new call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_CS_SESSION_INITIATE 730 - -/** - * Client <-> Server meessage to accept an incoming call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_CS_SESSION_ACCEPT 731 - -/** - * Client <-> Server message to reject an incoming call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_CS_SESSION_REJECT 732 - -/** - * Client <-> Server message to terminate a call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_CS_SESSION_TERMINATE 733 - -/** - * Client <-> Server message to initiate a new call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_CS_TEST 734 - -/** - * Server <-> Client message to initiate a new call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_SESSION_INITIATE 735 - -/** - * Server <-> Client meessage to accept an incoming call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_SESSION_ACCEPT 736 - -/** - * Server <-> Client message to reject an incoming call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_SESSION_REJECT 737 - -/** - * Server <-> Client message to terminat a call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_SESSION_TERMINATE 738 - -/** - * Server <-> Client message to signalize the client that the service is already in use - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_SERVICE_BLOCKED 739 - -/** - * Server <-> Client message to signalize the client that the called peer is not connected - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_PEER_NOT_CONNECTED 740 - -/** - * Server <-> Client message to signalize the client that called peer does not answer - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_NO_ANSWER 741 - -/** - * Server <-> Client message to notify client of missed call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_MISSED_CALL 742 - -/** - * Server <-> Client message to signalize the client that there occured an error - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_ERROR 743 - -/** - * Server <-> Client message to notify client of peer being available - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_SC_PEER_AVAILABLE 744 - -/** - * Mesh message to sinal the remote peer the wish to initiate a new call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_MESH_SESSION_INITIATE 745 - -/** - * Mesh message to signal the remote peer the acceptance of an initiated call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_MESH_SESSION_ACCEPT 746 - -/** - * Mesh message to reject an a wish to initiate a new call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_MESH_SESSION_REJECT 747 - -/** - * Mesh message to signal a remote peer the terminatation of a call - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_MESH_SESSION_TERMINATE 748 - -/** - * Server <-> Client message to notify client of peer being available - */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_MESH_PEER_AVAILABLE 749 - - -#define GNUNET_MESSAGE_TYPE_CONVERSATION_TEST 750 - - - -/** * Message to transmit the audio between helper and speaker/microphone library. */ -#define GNUNET_MESSAGE_TYPE_CONVERSATION_AUDIO 751 +#define GNUNET_MESSAGE_TYPE_CONVERSATION_AUDIO 730 /** * Client -> Server message register a phone. @@ -2307,7 +2202,7 @@ extern "C" /** * Multicast message from the origin to all members. */ -#define GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE 760 +#define GNUNET_MESSAGE_TYPE_MULTICAST_MESSAGE 750 /** * A unicast message from a group member to the origin. |