[vlc-devel] commit: RTP: some documentation ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <rdenis at simphalempin.com> | Thu Nov 27 18:44:15 2008 +0200| [627acb5550a9c6b399500a22a2c1b94bf3795958] | committer: Rémi Denis-Courmont 

RTP: some documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=627acb5550a9c6b399500a22a2c1b94bf3795958
---

 modules/access/rtp/session.c |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)

diff --git a/modules/access/rtp/session.c b/modules/access/rtp/session.c
index 9756ba8..f6e2793 100644
--- a/modules/access/rtp/session.c
+++ b/modules/access/rtp/session.c
@@ -223,7 +223,8 @@ rtp_find_ptype (const rtp_session_t *session, rtp_source_t *source,
 }
 
 /**
- * Receives an RTP packet and queues it.
+ * Receives an RTP packet and queues it. Not a cancellation point.
+ *
  * @param demux VLC demux object
  * @param session RTP session receiving the packet
  * @param block RTP packet including the RTP header
@@ -440,6 +441,15 @@ drop:
 }
 
 
+/**
+ * Dequeues an RTP packet and pass it to decoder. Not cancellation-safe(?).
+ *
+ * @param demux VLC demux object
+ * @param session RTP session receiving the packet
+ * @param deadlinep pointer to deadline to call rtp_dequeue() again
+ * @return true if the buffer is not empty, false otherwise.
+ * In the later case, *deadlinep is undefined.
+ */
 bool rtp_dequeue (demux_t *demux, const rtp_session_t *session,
                   mtime_t *restrict deadlinep)
 {