summaryrefslogtreecommitdiff
path: root/gst/rtsp-server/rtsp-server.c
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2015-07-23 14:50:30 -0400
committerNicolas Dufresne <nicolas.dufresne@collabora.com>2015-08-10 12:18:53 -0400
commit8511ffe1788926f27978c26390619251343ae5f9 (patch)
tree85bdabfee66d63ef2dd2e979ffdf56bb5121db5f /gst/rtsp-server/rtsp-server.c
parent3667e71b2f8008fd40fdc17d62743d9d0bda3582 (diff)
Document that source keeps a ref on server until it's destroyed
https://bugzilla.gnome.org/show_bug.cgi?id=749227
Diffstat (limited to 'gst/rtsp-server/rtsp-server.c')
-rw-r--r--gst/rtsp-server/rtsp-server.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/gst/rtsp-server/rtsp-server.c b/gst/rtsp-server/rtsp-server.c
index 686ba03..45ae9db 100644
--- a/gst/rtsp-server/rtsp-server.c
+++ b/gst/rtsp-server/rtsp-server.c
@@ -1246,6 +1246,8 @@ watch_destroyed (GstRTSPServer * server)
* unless cancellation happened at the same time as a condition change). You can
* check for this in the callback using g_cancellable_is_cancelled().
*
+ * This takes a reference on @server until @source is destroyed.
+ *
* Returns: (transfer full): the #GSource for @server or %NULL when an error
* occurred. Free with g_source_unref ()
*/
@@ -1304,6 +1306,12 @@ no_socket:
* This function should be called when the server properties and urls are fully
* configured and the server is ready to start.
*
+ * This takes a reference on @server until the source is destroyed. Note that
+ * if @context is not the default main context as returned by
+ * g_main_context_default() (or %NULL), g_source_remove() cannot be used to
+ * destroy the source. In that case it is recommended to use
+ * gst_rtsp_server_create_source() and attach it to @context manually.
+ *
* Returns: the ID (greater than 0) for the source within the GMainContext.
*/
guint