gnunet_conversation_service.h

Go to the documentation of this file.

/*
   This file is part of GNUnet
   Copyright (C) 2013, 2014, 2016 GNUnet e.V.

   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   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
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */

#ifndef GNUNET_CONVERSATION_SERVICE_H
#define GNUNET_CONVERSATION_SERVICE_H

#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif

#include "gnunet_util_lib.h"
#include "gnunet_identity_service.h"
#include "gnunet_namestore_service.h"
#include "gnunet_speaker_lib.h"
#include "gnunet_microphone_lib.h"


#define GNUNET_CONVERSATION_VERSION 0x00000004

struct GNUNET_CONVERSATION_Caller;


GNUNET_NETWORK_STRUCT_BEGIN

struct GNUNET_CONVERSATION_PhoneRecord
{
  uint32_t version GNUNET_PACKED;

  uint32_t reserved GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_HashCode line_port;
};

GNUNET_NETWORK_STRUCT_END

enum GNUNET_CONVERSATION_PhoneEventCode
{
  GNUNET_CONVERSATION_EC_PHONE_RING,

  GNUNET_CONVERSATION_EC_PHONE_HUNG_UP
};


typedef void
(*GNUNET_CONVERSATION_PhoneEventHandler)(void *cls,
                                         enum GNUNET_CONVERSATION_PhoneEventCode
                                         code,
                                         struct GNUNET_CONVERSATION_Caller *
                                         caller,
                                         const struct
                                         GNUNET_IDENTITY_PublicKey *caller_id);


enum GNUNET_CONVERSATION_CallerEventCode
{
  GNUNET_CONVERSATION_EC_CALLER_SUSPEND,

  GNUNET_CONVERSATION_EC_CALLER_RESUME
};


typedef void
(*GNUNET_CONVERSATION_CallerEventHandler)(void *cls,
                                          enum
                                          GNUNET_CONVERSATION_CallerEventCode
                                          code);


struct GNUNET_CONVERSATION_Phone;


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);


void
GNUNET_CONVERSATION_phone_get_record (struct GNUNET_CONVERSATION_Phone *phone,
                                      struct GNUNET_GNSRECORD_Data *rd);


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);


void
GNUNET_CONVERSATION_caller_suspend (struct GNUNET_CONVERSATION_Caller *caller);


void
GNUNET_CONVERSATION_caller_resume (struct GNUNET_CONVERSATION_Caller *caller,
                                   struct GNUNET_SPEAKER_Handle *speaker,
                                   struct GNUNET_MICROPHONE_Handle *mic);


void
GNUNET_CONVERSATION_caller_hang_up (struct GNUNET_CONVERSATION_Caller *caller);


void
GNUNET_CONVERSATION_phone_destroy (struct GNUNET_CONVERSATION_Phone *phone);


/* *********************** CALL API ************************ */

struct GNUNET_CONVERSATION_Call;


enum GNUNET_CONVERSATION_CallEventCode
{
  GNUNET_CONVERSATION_EC_CALL_RINGING,

  GNUNET_CONVERSATION_EC_CALL_PICKED_UP,

  GNUNET_CONVERSATION_EC_CALL_GNS_FAIL,

  GNUNET_CONVERSATION_EC_CALL_HUNG_UP,

  GNUNET_CONVERSATION_EC_CALL_SUSPENDED,

  GNUNET_CONVERSATION_EC_CALL_RESUMED,

  GNUNET_CONVERSATION_EC_CALL_ERROR
};


typedef void
(*GNUNET_CONVERSATION_CallEventHandler)(void *cls,
                                        enum GNUNET_CONVERSATION_CallEventCode
                                        code);


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);


void
GNUNET_CONVERSATION_call_suspend (struct GNUNET_CONVERSATION_Call *call);


void
GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call,
                                 struct GNUNET_SPEAKER_Handle *speaker,
                                 struct GNUNET_MICROPHONE_Handle *mic);


void
GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call);


#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif

#endif
  /* end of group */