summaryrefslogtreecommitdiffstats
path: root/libdash/include/IDownloadObserver.h
diff options
context:
space:
mode:
Diffstat (limited to 'libdash/include/IDownloadObserver.h')
-rw-r--r--libdash/include/IDownloadObserver.h58
1 files changed, 58 insertions, 0 deletions
diff --git a/libdash/include/IDownloadObserver.h b/libdash/include/IDownloadObserver.h
new file mode 100644
index 00000000..b78198d4
--- /dev/null
+++ b/libdash/include/IDownloadObserver.h
@@ -0,0 +1,58 @@
+/**
+ * @class dash::network::IDownloadObserver
+ * @brief This interface is needed for informing the application of the state of the download process.
+ * @details Informs the application about the download rate and the state of the download.
+ *
+ * @author bitmovin Softwareentwicklung OG \n
+ * Email: libdash-dev@vicky.bitmovin.net
+ * @version 2.1
+ * @date 2013
+ * @copyright bitmovin Softwareentwicklung OG, All Rights Reserved \n\n
+ * This source code and its use and distribution, is subject to the terms
+ * and conditions of the applicable license agreement.
+ */
+
+#ifndef IDOWNLOADOBSERVER_H_
+#define IDOWNLOADOBSERVER_H_
+
+#include "config.h"
+
+namespace dash
+{
+ namespace network
+ {
+ enum DownloadState
+ {
+ NOT_STARTED = 0,
+ IN_PROGRESS = 1,
+ REQUEST_ABORT = 2,
+ ABORTED = 3,
+ COMPLETED = 4
+ };
+ class IDownloadObserver
+ {
+ public:
+ virtual ~IDownloadObserver(){}
+
+ /**
+ * Informs the dash::network::IDownloadObserver object that the download rate has changed.
+ * @param bytesDownloaded the number of downloaded bytes
+ */
+ virtual void OnDownloadRateChanged (uint64_t bytesDownloaded) = 0;
+
+ /**
+ * Informs the dash::network::IDownloadObserver object that the downloading time has changed.
+ * @param downloadingTime the time taken for the downloading of this segment in seconds
+ */
+ virtual void OnDownloadTimeChanged (double downloadingTime) = 0;
+
+ /**
+ * Informs the dash::network::IDownloadObserver object that the download state has changed.
+ * @param state the download state
+ */
+ virtual void OnDownloadStateChanged (DownloadState state) = 0;
+ };
+ }
+}
+
+#endif /* IDOWNLOADOBSERVER_H_ */