ice.h

Go to the documentation of this file.

 
#pragma once
 
/* Storage capacities in elements; text buffers include the terminating NUL. */
#define NETWORK_WEBRTC_ICE_FOUNDATION_BUFFER_SIZE 32
#define NETWORK_WEBRTC_ICE_RADDR_BUFFER_SIZE 64
#define NETWORK_WEBRTC_ICE_EXTENSIONS_BUFFER_SIZE 256
 
#include <ascii-chat/common/limits.h>
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "../../common.h"
#include "../../asciichat_errno.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * ICE Candidate Types
 * ============================================================================ */

typedef enum {
  ICE_CANDIDATE_HOST = 0,  
  ICE_CANDIDATE_SRFLX = 1, 
  ICE_CANDIDATE_PRFLX = 2, 
  ICE_CANDIDATE_RELAY = 3, 
} ice_candidate_type_t;

typedef enum {
  ICE_PROTOCOL_UDP = 0,
  ICE_PROTOCOL_TCP = 1,
} ice_protocol_t;

typedef enum {
  ICE_TCP_TYPE_ACTIVE = 0,  
  ICE_TCP_TYPE_PASSIVE = 1, 
  ICE_TCP_TYPE_SO = 2,      
} ice_tcp_type_t;

typedef struct {
  /* Core candidate info */
  char foundation[NETWORK_WEBRTC_ICE_FOUNDATION_BUFFER_SIZE]; 
  uint32_t component_id;                                      
  ice_protocol_t protocol;                                    
  uint32_t priority;                                          
 
  /* Address info */
  char ip_address[IP_ADDRESS_BUFFER_SIZE]; 
  uint16_t port;                           
 
  /* Candidate type and attributes */
  ice_candidate_type_t type; 
 
  /* For srflx/prflx candidates: original address before NAT */
  char raddr[NETWORK_WEBRTC_ICE_RADDR_BUFFER_SIZE]; 
  uint16_t rport;                                   
 
  /* For TCP candidates */
  ice_tcp_type_t tcp_type; 
 
  /* Extensions */
  char extensions[NETWORK_WEBRTC_ICE_EXTENSIONS_BUFFER_SIZE]; 
} ice_candidate_t;
 
/* ============================================================================
 * ICE Gathering and Exchange
 * ============================================================================ */

typedef asciichat_error_t (*ice_send_candidate_callback_t)(const ice_candidate_t *candidate, const char *mid,
                                                           void *user_data);

typedef struct {
  const char *ufrag;                           
  const char *pwd;                             
  ice_send_candidate_callback_t send_callback; 
  void *user_data;                             
} ice_config_t;

asciichat_error_t ice_gather_candidates(const ice_config_t *config);
 
/* ============================================================================
 * ICE Candidate Parsing and Formatting
 * ============================================================================ */

asciichat_error_t ice_parse_candidate(const char *line, ice_candidate_t *candidate);

asciichat_error_t ice_format_candidate(const ice_candidate_t *candidate, char *line, size_t line_size);

uint32_t ice_calculate_priority(ice_candidate_type_t type, uint16_t local_preference, uint8_t component_id);

uint32_t ice_calculate_priority_for_candidate(const ice_candidate_t *candidate);
 
/* ============================================================================
 * ICE Connectivity
 * ============================================================================ */
 
/* Forward declaration */
struct webrtc_peer_connection;

asciichat_error_t ice_add_remote_candidate(struct webrtc_peer_connection *pc, const ice_candidate_t *candidate,
                                           const char *mid);

bool ice_is_connected(struct webrtc_peer_connection *pc);

int webrtc_get_rtc_id(struct webrtc_peer_connection *pc);

asciichat_error_t ice_get_selected_pair(struct webrtc_peer_connection *pc, ice_candidate_t *local_candidate,
                                        ice_candidate_t *remote_candidate);
 
/* ============================================================================
 * Utility Functions
 * ============================================================================ */

const char *ice_candidate_type_name(ice_candidate_type_t type);

const char *ice_protocol_name(ice_protocol_t protocol);
 
#ifdef __cplusplus
}
#endif