[rygel] docs: RygelDataSource: Add description



commit c8ac71055a6fadf3b048fad2979ca6051e22023e
Author: Murray Cumming <murrayc openismus com>
Date:   Mon Feb 11 11:28:06 2013 +0100

    docs: RygelDataSource: Add description
    
    Add some text from Mark Ryan.

 src/librygel-server/rygel-data-source.vala |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/src/librygel-server/rygel-data-source.vala b/src/librygel-server/rygel-data-source.vala
index 3d70998..8eebcf6 100644
--- a/src/librygel-server/rygel-data-source.vala
+++ b/src/librygel-server/rygel-data-source.vala
@@ -28,6 +28,14 @@ public errordomain Rygel.DataSourceError {
 /**
  * Interface for all data streams provided by a #RygelMediaEngine.
  *
+ * When Rygel receives a HTTP request to stream a given file, it creates a
+ * RygelDataSource object for this new file and instructs the RygelDataSource
+ * to begin streaming. The RygelDataSource object will duly pass this request
+ * on to the underlying media framework, which will in turn pass streamed bytes
+ * back to the RygelDataSource object. The RygelDataSource passes these bytes
+ * to Rygel which adds them to the response it sends to the original HTTP
+ * request received from the client.
+ *
  * The data source is responsible for providing the streamable byte-stream
  * via its data_available signal. End-of-stream is signalled by the 
  * done signal, while errors are signalled by the error signal.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]