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
605f2e19
Commit
605f2e19
authored
Feb 04, 2007
by
Dafydd Harries
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
improve agent docstrings
darcs-hash:20070204190024-c9803-8a570bbe8c52516e779f3d0d9a232c39e2d6b09e.gz
parent
a1dfecc8
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
21 deletions
+30
-21
agent/agent.c
agent/agent.c
+30
-21
No files found.
agent/agent.c
View file @
605f2e19
...
...
@@ -144,10 +144,11 @@ candidate_pair_priority (
/**
* nice_agent_new:
*
* @factory: a NiceUDPSocketFactory used for allocating sockets
*
* Create a new NiceAgent.
*
* Returns: the new agent
**/
NiceAgent
*
nice_agent_new
(
NiceUDPSocketFactory
*
factory
)
...
...
@@ -229,11 +230,13 @@ nice_agent_add_local_host_candidate (
/**
* nice_agent_add_stream:
*
* @agent: a NiceAgent
* @handle_recv: A function called when the stream recieves data
* @handle_recv: a function called when the stream recieves data
* @handle_recv_data: data passed as last parameter to @handle_recv
*
* Add a data stream to @agent.
*
* Returns: the ID of the new stream
**/
guint
nice_agent_add_stream
(
...
...
@@ -269,9 +272,8 @@ nice_agent_add_stream (
/**
* nice_agent_add_local_address:
*
* @agent: A NiceAgent
*
@addr: T
he address of a local IP interface
*
@addr: t
he address of a local IP interface
*
* Inform the agent of the presence of an address that a local network
* interface is bound to.
...
...
@@ -290,14 +292,14 @@ nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr)
/**
* nice_agent_add_remote_candidate
* @agent:
The a
gent
* @stream_id:
T
he ID of the stream the candidate is for
* @c
andidate_id: The ID of the candidate
the candidate is for
* @type:
T
he type of the new candidate
* @addr:
T
he new candidate's IP address
* @port:
T
he new candidate's port
* @username:
T
he new candidate's username
* @password:
T
he new candidate's password
* @agent:
a NiceA
gent
* @stream_id:
t
he ID of the stream the candidate is for
* @c
omponent_id: the ID of the component
the candidate is for
* @type:
t
he type of the new candidate
* @addr:
t
he new candidate's IP address
* @port:
t
he new candidate's port
* @username:
t
he new candidate's username
* @password:
t
he new candidate's password
*
* Add a candidate our peer has informed us about to the agent's list.
**/
...
...
@@ -612,15 +614,15 @@ nice_agent_recv (
/**
* nice_agent_poll_read:
* @agent: A NiceAgent
* @other_fds: A GSList of other file descriptors to poll
*
* Polls the agent's sockets until at least one of them is readable, and
* additionally if @other_fds is not NULL, polls those for readability too.
* @other_fds should contain the file descriptors directly, i.e. using
* GUINT_TO_POINTER.
*
* @agent: A NiceAgent
* @other_fds: A GSList of other file descriptors to poll
* Return value: A list of file descriptors from @other_fds that are readable
* Returns: A list of file descriptors from @other_fds that are readable
**/
GSList
*
nice_agent_poll_read
(
NiceAgent
*
agent
,
GSList
*
other_fds
)
...
...
@@ -692,11 +694,12 @@ nice_agent_set_stun_server (NiceAddress *addr, guint16 port)
/**
* nice_agent_get_local_candidates:
*
* @agent: A NiceAgent
* Return value: a GSList of local candidates belonging to @agent
*
* The caller does not own the GSList or the candidates contained within it.
* The caller does not own the returned GSList or the candidates contained
* within it.
*
* Returns: a GSList of local candidates belonging to @agent
**/
const
GSList
*
nice_agent_get_local_candidates
(
...
...
@@ -705,6 +708,12 @@ nice_agent_get_local_candidates (
return
agent
->
local_candidates
;
}
/**
* nice_agent_free:
* @agent: a NiceAgent
*
* Free the agent.
**/
void
nice_agent_free
(
NiceAgent
*
agent
)
{
...
...
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