Commit c0ca6c65 authored by Youness Alaoui's avatar Youness Alaoui Committed by Olivier Crête

Fix documentation in preparation for ice-tcp support

parent a9b439ed
......@@ -573,8 +573,8 @@ nice_agent_class_init (NiceAgentClass *klass)
/**
* NiceAgent:reliable:
*
* Whether the agent should use PseudoTcp to ensure a reliable transport
* of messages
* Whether the agent is providing a reliable transport of messages (through
* ICE-TCP or PseudoTCP over ICE-UDP)
*
* Since: 0.0.11
*/
......@@ -582,8 +582,7 @@ nice_agent_class_init (NiceAgentClass *klass)
g_param_spec_boolean (
"reliable",
"reliable mode",
"Whether the agent should use PseudoTcp to ensure a reliable transport"
"of messages",
"Whether the agent provides a reliable transport of messages",
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
......
......@@ -291,7 +291,8 @@ typedef enum
/**
* NiceCompatibility:
* @NICE_COMPATIBILITY_RFC5245: Use compatibility with the RFC5245 ICE specs
* @NICE_COMPATIBILITY_RFC5245: Use compatibility with the RFC5245 ICE-UDP specs
* and RFC6544 ICE-TCP specs
* @NICE_COMPATIBILITY_GOOGLE: Use compatibility for Google Talk specs
* @NICE_COMPATIBILITY_MSN: Use compatibility for MSN Messenger specs
* @NICE_COMPATIBILITY_WLM2009: Use compatibility with Windows Live Messenger
......@@ -307,16 +308,26 @@ typedef enum
* <warning>@NICE_COMPATIBILITY_DRAFT19 is deprecated and should not be used
* in newly-written code. It is kept for compatibility reasons and
* represents the same compatibility as @NICE_COMPATIBILITY_RFC5245 </warning>
<note>
<para>
If @NICE_COMPATIBILITY_RFC5245 compatibility mode is used for a non-reliable
agent, then ICE-UDP will be used with higher priority and ICE-TCP will also
be used when the UDP connectivity fails. If it is used with a reliable agent,
then ICE-UDP will be used with the TCP-Over-UDP (#PseudoTcpSocket) if ICE-TCP
fails and ICE-UDP succeeds.
</para>
</note>
*
*/
typedef enum
{
NICE_COMPATIBILITY_RFC5245 = 0,
NICE_COMPATIBILITY_DRAFT19 = NICE_COMPATIBILITY_RFC5245,
NICE_COMPATIBILITY_GOOGLE,
NICE_COMPATIBILITY_MSN,
NICE_COMPATIBILITY_WLM2009,
NICE_COMPATIBILITY_OC2007,
NICE_COMPATIBILITY_OC2007R2,
NICE_COMPATIBILITY_DRAFT19 = NICE_COMPATIBILITY_RFC5245,
NICE_COMPATIBILITY_LAST = NICE_COMPATIBILITY_OC2007R2,
} NiceCompatibility;
......@@ -379,8 +390,9 @@ nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
* @ctx: The Glib Mainloop Context to use for timers
* @compat: The compatibility mode of the agent
*
* Create a new #NiceAgent in reliable mode, which uses #PseudoTcpSocket to
* assure reliability of the messages.
* Create a new #NiceAgent in reliable mode. If the connectivity is established
* through ICE-UDP, then a #PseudoTcpSocket will be transparently used to
* ensure reliability of the messages.
* The returned object must be freed with g_object_unref()
* <para> See also: #NiceAgent::reliable-transport-writable </para>
*
......
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