Commit 76f88930 authored by Kai Vehmanen's avatar Kai Vehmanen

Updated references to ICE ID-19, part 3.

darcs-hash:20071119131247-77cd4-ec8ba55d5ba1cec101612fa4b40cb2d725efc228.gz
parent c48c0ab5
...@@ -104,7 +104,7 @@ static gboolean priv_conn_check_initiate (NiceAgent *agent, CandidateCheckPair * ...@@ -104,7 +104,7 @@ static gboolean priv_conn_check_initiate (NiceAgent *agent, CandidateCheckPair *
/** /**
* Unfreezes the next connectivity check in the list. Follows the * Unfreezes the next connectivity check in the list. Follows the
* algorithm (2.) defined in 5.7.4 (Computing States) of the ICE spec * algorithm (2.) defined in 5.7.4 (Computing States) of the ICE spec
* (ID-18), with some exceptions (see comments in code). * (ID-19), with some exceptions (see comments in code).
* *
* See also sect 7.1.2.2.3 (Updating Pair States), and * See also sect 7.1.2.2.3 (Updating Pair States), and
* priv_conn_check_unfreeze_related(). * priv_conn_check_unfreeze_related().
...@@ -158,7 +158,7 @@ static gboolean priv_conn_check_unfreeze_next (NiceAgent *agent) ...@@ -158,7 +158,7 @@ static gboolean priv_conn_check_unfreeze_next (NiceAgent *agent)
* Unfreezes the next next connectivity check in the list after * Unfreezes the next next connectivity check in the list after
* check 'success_check' has succesfully completed. * check 'success_check' has succesfully completed.
* *
* See sect 7.1.2.2.3 (Updating Pair States) of ICE spec (ID-18). * See sect 7.1.2.2.3 (Updating Pair States) of ICE spec (ID-19).
* *
* @param agent context * @param agent context
* @param ok_check a connectivity check that has just completed * @param ok_check a connectivity check that has just completed
...@@ -394,7 +394,7 @@ static gboolean priv_conn_keepalive_tick (gpointer pointer) ...@@ -394,7 +394,7 @@ static gboolean priv_conn_keepalive_tick (gpointer pointer)
int errors = 0; int errors = 0;
/* case 1: session established and media flowing /* case 1: session established and media flowing
* (ref ICE sect 10 "Keepalives" ID-18) */ * (ref ICE sect 10 "Keepalives" ID-19) */
for (i = agent->streams; i; i = i->next) { for (i = agent->streams; i; i = i->next) {
Stream *stream = i->data; Stream *stream = i->data;
...@@ -420,7 +420,7 @@ static gboolean priv_conn_keepalive_tick (gpointer pointer) ...@@ -420,7 +420,7 @@ static gboolean priv_conn_keepalive_tick (gpointer pointer)
} }
/* case 2: connectivity establishment ongoing /* case 2: connectivity establishment ongoing
* (ref ICE sect 4.1.1.4 "Keeping Candidates Alive" ID-18) */ * (ref ICE sect 4.1.1.4 "Keeping Candidates Alive" ID-19) */
for (i = agent->streams; i; i = i->next) { for (i = agent->streams; i; i = i->next) {
Stream *stream = i->data; Stream *stream = i->data;
if (stream->conncheck_state == NICE_CHECKLIST_RUNNING) { if (stream->conncheck_state == NICE_CHECKLIST_RUNNING) {
...@@ -491,7 +491,7 @@ gint conn_check_compare (const CandidateCheckPair *a, const CandidateCheckPair * ...@@ -491,7 +491,7 @@ gint conn_check_compare (const CandidateCheckPair *a, const CandidateCheckPair *
/** /**
* Enforces the upper limit for connectivity checks as described * Enforces the upper limit for connectivity checks as described
* in ICE spec section 5.7.3 (ID-18). See also * in ICE spec section 5.7.3 (ID-19). See also
* conn_check_add_for_candidate(). * conn_check_add_for_candidate().
*/ */
static GSList *priv_limit_conn_check_list_size (GSList *conncheck_list, guint upper_limit) static GSList *priv_limit_conn_check_list_size (GSList *conncheck_list, guint upper_limit)
...@@ -564,7 +564,7 @@ static gboolean priv_add_new_check_pair (NiceAgent *agent, guint stream_id, Comp ...@@ -564,7 +564,7 @@ static gboolean priv_add_new_check_pair (NiceAgent *agent, guint stream_id, Comp
g_debug ("added a new conncheck %p with foundation of '%s' to list %u.", pair, pair->foundation, stream_id); g_debug ("added a new conncheck %p with foundation of '%s' to list %u.", pair, pair->foundation, stream_id);
/* implement the hard upper limit for number of /* implement the hard upper limit for number of
checks (see sect 5.7.3 ICE ID-18): */ checks (see sect 5.7.3 ICE ID-19): */
stream->conncheck_list = stream->conncheck_list =
priv_limit_conn_check_list_size (stream->conncheck_list, agent->max_conn_checks); priv_limit_conn_check_list_size (stream->conncheck_list, agent->max_conn_checks);
if (!stream->conncheck_list) { if (!stream->conncheck_list) {
...@@ -589,7 +589,7 @@ static gboolean priv_add_new_check_pair (NiceAgent *agent, guint stream_id, Comp ...@@ -589,7 +589,7 @@ static gboolean priv_add_new_check_pair (NiceAgent *agent, guint stream_id, Comp
* Forms new candidate pairs by matching the new remote candidate * Forms new candidate pairs by matching the new remote candidate
* 'remote_cand' with all existing local candidates of 'component'. * 'remote_cand' with all existing local candidates of 'component'.
* Implements the logic described in ICE sect 5.7.1. "Forming Candidate * Implements the logic described in ICE sect 5.7.1. "Forming Candidate
* Pairs" (ID-18). * Pairs" (ID-19).
* *
* @param agent context * @param agent context
* @param component pointer to the component * @param component pointer to the component
...@@ -613,7 +613,7 @@ int conn_check_add_for_candidate (NiceAgent *agent, guint stream_id, Component * ...@@ -613,7 +613,7 @@ int conn_check_add_for_candidate (NiceAgent *agent, guint stream_id, Component *
gboolean result; gboolean result;
/* note: do not create pairs where local candidate is /* note: do not create pairs where local candidate is
* a srv-reflexive (ICE 5.7.3. "Pruning the Pairs" ID-18) */ * a srv-reflexive (ICE 5.7.3. "Pruning the Pairs" ID-19) */
if (local->type == NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE) if (local->type == NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE)
continue; continue;
...@@ -835,7 +835,7 @@ int conn_check_send (NiceAgent *agent, CandidateCheckPair *pair) ...@@ -835,7 +835,7 @@ int conn_check_send (NiceAgent *agent, CandidateCheckPair *pair)
* Updates the check list state. * Updates the check list state.
* *
* Implements parts of the algorithm described in * Implements parts of the algorithm described in
* ICE sect 8.1.2. "Updating States" (ID-18) that apply * ICE sect 8.1.2. "Updating States" (ID-19) that apply
* to the whole check list. * to the whole check list.
*/ */
static void priv_update_check_list_state (NiceAgent *agent, Stream *stream) static void priv_update_check_list_state (NiceAgent *agent, Stream *stream)
...@@ -877,7 +877,7 @@ static void priv_update_check_list_state (NiceAgent *agent, Stream *stream) ...@@ -877,7 +877,7 @@ static void priv_update_check_list_state (NiceAgent *agent, Stream *stream)
/** /**
* Implemented the pruning steps described in ICE sect 8.1.2 * Implemented the pruning steps described in ICE sect 8.1.2
* "Updating States" (ID-18) after a pair has been nominated. * "Updating States" (ID-19) after a pair has been nominated.
* *
* @see priv_update_check_list_state_for_component() * @see priv_update_check_list_state_for_component()
*/ */
...@@ -893,7 +893,7 @@ static void priv_prune_pending_checks (/*NiceAgent *agent, */Stream *stream, gui ...@@ -893,7 +893,7 @@ static void priv_prune_pending_checks (/*NiceAgent *agent, */Stream *stream, gui
p->state == NICE_CHECK_WAITING) p->state == NICE_CHECK_WAITING)
p->state = NICE_CHECK_CANCELLED; p->state = NICE_CHECK_CANCELLED;
/* note: a SHOULD level req. in ICE 8.1.2. "Updating States" (ID-18) */ /* note: a SHOULD level req. in ICE 8.1.2. "Updating States" (ID-19) */
if (p->state == NICE_CHECK_IN_PROGRESS) { if (p->state == NICE_CHECK_IN_PROGRESS) {
if (p->stun_ctx) if (p->stun_ctx)
stun_bind_cancel (p->stun_ctx), stun_bind_cancel (p->stun_ctx),
...@@ -908,7 +908,7 @@ static void priv_prune_pending_checks (/*NiceAgent *agent, */Stream *stream, gui ...@@ -908,7 +908,7 @@ static void priv_prune_pending_checks (/*NiceAgent *agent, */Stream *stream, gui
* Updates the check list state for a stream component. * Updates the check list state for a stream component.
* *
* Implements the algorithm described in ICE sect 8.1.2 * Implements the algorithm described in ICE sect 8.1.2
* "Updating States" (ID-18) as it applies to checks of * "Updating States" (ID-19) as it applies to checks of
* a certain component. If any there are any nominated pairs, * a certain component. If any there are any nominated pairs,
* ICE processing may be concluded, and component state is * ICE processing may be concluded, and component state is
* changed to READY. * changed to READY.
...@@ -946,7 +946,7 @@ static void priv_update_check_list_state_for_component (NiceAgent *agent, Stream ...@@ -946,7 +946,7 @@ static void priv_update_check_list_state_for_component (NiceAgent *agent, Stream
/** /**
* Changes the selected pair for the component if 'pair' is nominated * Changes the selected pair for the component if 'pair' is nominated
* and has higher priority than the currently selected pair. See * and has higher priority than the currently selected pair. See
* ICE sect 11.1.1. "Procedures for Full Implementations" (ID-18). * ICE sect 11.1.1. "Procedures for Full Implementations" (ID-19).
*/ */
static gboolean priv_update_selected_pair (NiceAgent *agent, Component *component, CandidateCheckPair *pair) static gboolean priv_update_selected_pair (NiceAgent *agent, Component *component, CandidateCheckPair *pair)
{ {
...@@ -967,7 +967,7 @@ static gboolean priv_update_selected_pair (NiceAgent *agent, Component *componen ...@@ -967,7 +967,7 @@ static gboolean priv_update_selected_pair (NiceAgent *agent, Component *componen
/** /**
* Schedules a triggered check after a succesfully inbound * Schedules a triggered check after a succesfully inbound
* connectivity check. Implements ICE sect 7.2.1.4 "Triggered Checks" (ID-18). * connectivity check. Implements ICE sect 7.2.1.4 "Triggered Checks" (ID-19).
* *
* @param agent self pointer * @param agent self pointer
* @param component the check is related to * @param component the check is related to
...@@ -993,7 +993,7 @@ static gboolean priv_schedule_triggered_check (NiceAgent *agent, Stream *stream, ...@@ -993,7 +993,7 @@ static gboolean priv_schedule_triggered_check (NiceAgent *agent, Stream *stream,
priv_conn_check_initiate (agent, p); priv_conn_check_initiate (agent, p);
if (p->state == NICE_CHECK_IN_PROGRESS) { if (p->state == NICE_CHECK_IN_PROGRESS) {
/* XXX: according to ICE 7.2.1.4 "Triggered Checks" (ID-18), /* XXX: according to ICE 7.2.1.4 "Triggered Checks" (ID-19),
* we should cancel the existing one, and send a new one...? :P */ * we should cancel the existing one, and send a new one...? :P */
g_debug ("Skipping triggered check, already in progress.."); g_debug ("Skipping triggered check, already in progress..");
} }
...@@ -1170,7 +1170,7 @@ static void priv_check_for_role_conflict (NiceAgent *agent, gboolean control) ...@@ -1170,7 +1170,7 @@ static void priv_check_for_role_conflict (NiceAgent *agent, gboolean control)
/** /**
* Tries to match STUN reply in 'buf' to an existing STUN connectivity * Tries to match STUN reply in 'buf' to an existing STUN connectivity
* check transaction. If found, the reply is processed. Implements * check transaction. If found, the reply is processed. Implements
* section 7.1.2 "Processing the Response" of ICE spec (ID-18). * section 7.1.2 "Processing the Response" of ICE spec (ID-19).
* *
* @return TRUE if a matching transaction is found * @return TRUE if a matching transaction is found
*/ */
...@@ -1252,12 +1252,12 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, Stream * ...@@ -1252,12 +1252,12 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, Stream *
/* step: updating nominated flag (ICE 7.1.2.2.4 "Updating the /* step: updating nominated flag (ICE 7.1.2.2.4 "Updating the
Nominated Flag" (ID-18) */ Nominated Flag" (ID-19) */
if (ok_pair->nominated == TRUE) if (ok_pair->nominated == TRUE)
priv_update_selected_pair (agent, component, ok_pair); priv_update_selected_pair (agent, component, ok_pair);
/* step: update pair states (ICE 7.1.2.2.3 "Updating pair /* step: update pair states (ICE 7.1.2.2.3 "Updating pair
states" and 8.1.2 "Updating States", ID-18) */ states" and 8.1.2 "Updating States", ID-19) */
priv_update_check_list_state_for_component (agent, stream, component); priv_update_check_list_state_for_component (agent, stream, component);
trans_found = TRUE; trans_found = TRUE;
...@@ -1268,7 +1268,7 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, Stream * ...@@ -1268,7 +1268,7 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, Stream *
/* note: our role might already have changed due to an /* note: our role might already have changed due to an
* incoming request, but if not, change role now; * incoming request, but if not, change role now;
* follows ICE 7.1.2.1 "Failure Cases" (ID-18) */ * follows ICE 7.1.2.1 "Failure Cases" (ID-19) */
priv_check_for_role_conflict (agent, !p->controlling); priv_check_for_role_conflict (agent, !p->controlling);
p->stun_ctx = NULL; p->stun_ctx = NULL;
...@@ -1395,7 +1395,7 @@ gboolean conn_check_handle_inbound_stun (NiceAgent *agent, Stream *stream, Compo ...@@ -1395,7 +1395,7 @@ gboolean conn_check_handle_inbound_stun (NiceAgent *agent, Stream *stream, Compo
g_debug ("inbound STUN packet for %p/%u/%u (agent/stream/component):", agent, stream->id, component->id); g_debug ("inbound STUN packet for %p/%u/%u (agent/stream/component):", agent, stream->id, component->id);
/* note: ICE 7.2. "STUN Server Procedures" (ID-18) */ /* note: ICE 7.2. "STUN Server Procedures" (ID-19) */
res = stun_conncheck_reply (rbuf, &rbuf_len, (const uint8_t*)buf, &sockaddr, sizeof (sockaddr), res = stun_conncheck_reply (rbuf, &rbuf_len, (const uint8_t*)buf, &sockaddr, sizeof (sockaddr),
uname, stream->local_password, uname, stream->local_password,
...@@ -1444,7 +1444,7 @@ gboolean conn_check_handle_inbound_stun (NiceAgent *agent, Stream *stream, Compo ...@@ -1444,7 +1444,7 @@ gboolean conn_check_handle_inbound_stun (NiceAgent *agent, Stream *stream, Compo
gboolean trans_found = FALSE; gboolean trans_found = FALSE;
/* note: ICE sect 7.1.2. "Processing the Response" (ID-18) */ /* note: ICE sect 7.1.2. "Processing the Response" (ID-19) */
/* step: let's try to match the response to an existing check context */ /* step: let's try to match the response to an existing check context */
if (trans_found != TRUE) if (trans_found != TRUE)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment