tox_server.h

Go to the documentation of this file.

#ifndef TOX_SERVER_H
#define TOX_SERVER_H
 
#if defined _WIN32 || defined __CYGWIN__
#ifdef LIBTOX_SERVER_EXPORTS
#define TOX_SERVER_DEF_PREFIX __declspec(dllexport)
#else
#define TOX_SERVER_DEF_PREFIX __declspec(dllimport)
#endif
#elif __GNUC__ >= 4
#ifdef TOX_SERVER_EXPORT_SHARED
#define TOX_SERVER_DEF_PREFIX __attribute__((visibility("default")))
#else
#define TOX_SERVER_DEF_PREFIX
#endif
#else
#define TOX_SERVER_DEF_PREFIX
#endif
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define TOX_SERVER_VERSION "1.5.2"

typedef enum TOX_SERVER_ERROR {
  TOX_SERVER_NO_ERROR = 0,
  TOX_SERVER_UNKNOWN_ERROR,
  TOX_SERVER_BAD_INSTANCE,
  TOX_SERVER_BAD_ACCOUNT_UUID,
  TOX_SERVER_BAD_API_KEY,
  TOX_SERVER_BAD_CONFIG,
  TOX_SERVER_BAD_PLAYER_NAME,
  TOX_SERVER_BAD_SESSION_NAME,
  TOX_SERVER_BAD_MAX_NUM_PACKETS,
  TOX_SERVER_BAD_MAX_PACKET_SIZE,
  TOX_SERVER_BAD_PACKET,
  TOX_SERVER_CURL_ERROR,
  TOX_SERVER_EMPTY_PACKET,
  TOX_SERVER_PACKET_TOO_LARGE,
  TOX_SERVER_CIRCULAR_BUFFER_FULL,
  TOX_SERVER_UPLOAD_QUEUE_FULL,
  TOX_SERVER_BAD_MEM_FUNCTION,
  TOX_SERVER_UPLOAD_METADATA_FAILED,
  TOX_SERVER_BAD_PLAYER_ALIAS,
  TOX_SERVER_BAD_SESSION_ALIAS,
  TOX_SERVER_BAD_PLAYER_LIST,
  TOX_SERVER_PROXIMITY_CHAT_DISABLED,
  TOX_SERVER_BAD_REALTIME_CONFIG
} TOX_SERVER_ERROR;

typedef struct {
  void* tox_internal_ptr;
} tox_server_instance_t;

typedef struct {
  const char* player_name_unique;
  const char* session_name_unique;
  unsigned long circular_buffer_max_num_packets;
  unsigned long max_packet_size; 
  int obscure_names;
  int enable_proximity_chat;

  int is_nonrealtime;
} tox_server_config_t;

TOX_SERVER_DEF_PREFIX const char* tox_server_get_version(void);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_set_log_info_callback(void (*log_info_callback)(const char*));

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_set_log_error_callback(void (*log_error_callback)(const char*));

TOX_SERVER_DEF_PREFIX const char* tox_server_error_name(TOX_SERVER_ERROR error);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_global_init(const char* account_uuid,
                                                              const char* api_key,
                                                              const char* single_tenant_prefix);

typedef void* (*tox_server_malloc_callback)(size_t size);
typedef void (*tox_server_free_callback)(void* ptr);
typedef void* (*tox_server_realloc_callback)(void* ptr, size_t size);
typedef char* (*tox_server_strdup_callback)(const char* str);
typedef void* (*tox_server_calloc_callback)(size_t nmemb, size_t size);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_global_init_mem(
  const char* account_uuid, const char* api_key, const char* single_tenant_prefix,
  tox_server_malloc_callback tox_malloc, tox_server_free_callback tox_free,
  tox_server_realloc_callback tox_realloc, tox_server_strdup_callback tox_strdup,
  tox_server_calloc_callback tox_calloc);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_global_cleanup(void);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_create_instance(
  tox_server_instance_t* tox_instance_ptr, const tox_server_config_t* tox_server_config_ptr);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_destroy_instance(tox_server_instance_t* tox_instance_ptr);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_get_internal_player_uuid(
  tox_server_instance_t* tox_instance_ptr, const char** internal_player_uuid);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_get_internal_session_uuid(
  tox_server_instance_t* tox_instance_ptr, const char** internal_session_uuid);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_add_session_data(tox_server_instance_t* tox_instance_ptr, const char* session_data);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_set_proximity_chat_player_can_hear(
  tox_server_instance_t* tox_instance_ptr, const char* const* players, unsigned int num_players);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_set_proximity_chat_can_hear_player(
  tox_server_instance_t* tox_instance_ptr, const char* const* players, unsigned int num_players);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_add_packet(
  tox_server_instance_t* tox_instance_ptr, const unsigned char* packet, unsigned int packet_size);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_add_packets_nonrealtime(
  tox_server_instance_t* tox_instance_ptr, const unsigned char** packets,
  const unsigned int* packet_sizes, unsigned int num_packets);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_set_global_muted(tox_server_instance_t* tox_instance_ptr, int muted);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_set_player_muted(
  tox_server_instance_t* tox_instance_ptr, const char* player, int muted);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_set_players_muted_at_join(
  tox_server_instance_t* tox_instance_ptr, const char* const* players, unsigned int num_players);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_run_buffer_copy(tox_server_instance_t* tox_instance_ptr);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_begin_upload(tox_server_instance_t* tox_instance_ptr);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_run_all_uploads_with_timeout(int* num_running_uploads, int wait_timeout_milliseconds);
 
/**** Deprecated Functions, Do Not Use For New Applications ***/

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR tox_server_run_all_uploads(int* num_running_uploads);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_set_player_alias(tox_server_instance_t* tox_instance_ptr, const char* player_alias);

TOX_SERVER_DEF_PREFIX TOX_SERVER_ERROR
  tox_server_set_session_alias(tox_server_instance_t* tox_instance_ptr, const char* session_alias);
 
#ifdef __cplusplus
}
#endif
 
#endif