[Pkg-telepathy-commits] [libnice] 16/265: agent: Clarify valid range of stream and component IDs

[Simon McVittie]

This is an automated email from the git hooks/post-receive script.

smcv pushed a commit to branch debian
in repository libnice.

commit 483a0fcc2bca0d8d1018a92e13565866b88124cd
Author: Philip Withnall <philip.withnall at collabora.co.uk>
Date:   Thu Dec 12 11:30:04 2013 +0000

    agent: Clarify valid range of stream and component IDs
    
    Valid IDs will never be 0, which is convenient.
---
 agent/agent.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/agent/agent.h b/agent/agent.h
index 7b2f45b..5267797 100644
--- a/agent/agent.h
+++ b/agent/agent.h
@@ -53,6 +53,10 @@
  * It will take care of discovering your local candidates and do
  *  connectivity checks to create a stream of data between you and your peer.
  *
+ * Streams and their components are referenced by integer IDs (with respect to a
+ * given #NiceAgent). These IDs are guaranteed to be positive (i.e. non-zero)
+ * for valid streams/components.
+ *
  <example>
    <title>Simple example on how to use libnice</title>
    <programlisting>
@@ -338,7 +342,8 @@ nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr);
  * @agent: The #NiceAgent Object
  * @n_components: The number of components to add to the stream
  *
- * Adds a data stream to @agent containing @n_components components.
+ * Adds a data stream to @agent containing @n_components components. The
+ * returned stream ID is guaranteed to be positive on success.
  *
  * Returns: The ID of the new stream, 0 on failure
  **/

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-telepathy/libnice.git