Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
L
libnice
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
cpp-libs
libnice
Commits
c0ca6c65
Commit
c0ca6c65
authored
Mar 31, 2014
by
Youness Alaoui
Committed by
Olivier Crête
May 15, 2014
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix documentation in preparation for ice-tcp support
parent
a9b439ed
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
19 additions
and
8 deletions
+19
-8
agent/agent.c
agent/agent.c
+3
-4
agent/agent.h
agent/agent.h
+16
-4
No files found.
agent/agent.c
View file @
c0ca6c65
...
@@ -573,8 +573,8 @@ nice_agent_class_init (NiceAgentClass *klass)
...
@@ -573,8 +573,8 @@ nice_agent_class_init (NiceAgentClass *klass)
/**
/**
* NiceAgent:reliable:
* NiceAgent:reliable:
*
*
* Whether the agent
should use PseudoTcp to ensure a reliable transport
* Whether the agent
is providing a reliable transport of messages (through
*
of messages
*
ICE-TCP or PseudoTCP over ICE-UDP)
*
*
* Since: 0.0.11
* Since: 0.0.11
*/
*/
...
@@ -582,8 +582,7 @@ nice_agent_class_init (NiceAgentClass *klass)
...
@@ -582,8 +582,7 @@ nice_agent_class_init (NiceAgentClass *klass)
g_param_spec_boolean
(
g_param_spec_boolean
(
"reliable"
,
"reliable"
,
"reliable mode"
,
"reliable mode"
,
"Whether the agent should use PseudoTcp to ensure a reliable transport"
"Whether the agent provides a reliable transport of messages"
,
"of messages"
,
FALSE
,
FALSE
,
G_PARAM_READWRITE
|
G_PARAM_CONSTRUCT_ONLY
));
G_PARAM_READWRITE
|
G_PARAM_CONSTRUCT_ONLY
));
...
...
agent/agent.h
View file @
c0ca6c65
...
@@ -291,7 +291,8 @@ typedef enum
...
@@ -291,7 +291,8 @@ typedef enum
/**
/**
* NiceCompatibility:
* 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_GOOGLE: Use compatibility for Google Talk specs
* @NICE_COMPATIBILITY_MSN: Use compatibility for MSN Messenger specs
* @NICE_COMPATIBILITY_MSN: Use compatibility for MSN Messenger specs
* @NICE_COMPATIBILITY_WLM2009: Use compatibility with Windows Live Messenger
* @NICE_COMPATIBILITY_WLM2009: Use compatibility with Windows Live Messenger
...
@@ -307,16 +308,26 @@ typedef enum
...
@@ -307,16 +308,26 @@ typedef enum
* <warning>@NICE_COMPATIBILITY_DRAFT19 is deprecated and should not be used
* <warning>@NICE_COMPATIBILITY_DRAFT19 is deprecated and should not be used
* in newly-written code. It is kept for compatibility reasons and
* in newly-written code. It is kept for compatibility reasons and
* represents the same compatibility as @NICE_COMPATIBILITY_RFC5245 </warning>
* 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
typedef
enum
{
{
NICE_COMPATIBILITY_RFC5245
=
0
,
NICE_COMPATIBILITY_RFC5245
=
0
,
NICE_COMPATIBILITY_DRAFT19
=
NICE_COMPATIBILITY_RFC5245
,
NICE_COMPATIBILITY_GOOGLE
,
NICE_COMPATIBILITY_GOOGLE
,
NICE_COMPATIBILITY_MSN
,
NICE_COMPATIBILITY_MSN
,
NICE_COMPATIBILITY_WLM2009
,
NICE_COMPATIBILITY_WLM2009
,
NICE_COMPATIBILITY_OC2007
,
NICE_COMPATIBILITY_OC2007
,
NICE_COMPATIBILITY_OC2007R2
,
NICE_COMPATIBILITY_OC2007R2
,
NICE_COMPATIBILITY_DRAFT19
=
NICE_COMPATIBILITY_RFC5245
,
NICE_COMPATIBILITY_LAST
=
NICE_COMPATIBILITY_OC2007R2
,
NICE_COMPATIBILITY_LAST
=
NICE_COMPATIBILITY_OC2007R2
,
}
NiceCompatibility
;
}
NiceCompatibility
;
...
@@ -379,8 +390,9 @@ nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
...
@@ -379,8 +390,9 @@ nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
* @ctx: The Glib Mainloop Context to use for timers
* @ctx: The Glib Mainloop Context to use for timers
* @compat: The compatibility mode of the agent
* @compat: The compatibility mode of the agent
*
*
* Create a new #NiceAgent in reliable mode, which uses #PseudoTcpSocket to
* Create a new #NiceAgent in reliable mode. If the connectivity is established
* assure reliability of the messages.
* 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()
* The returned object must be freed with g_object_unref()
* <para> See also: #NiceAgent::reliable-transport-writable </para>
* <para> See also: #NiceAgent::reliable-transport-writable </para>
*
*
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment