aboutsummaryrefslogtreecommitdiffstats
path: root/src/libdash/include/IDownloadObserver.h
blob: b78198d4f16e9ad5eea3f148bc2b70cb09e50c4a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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_ */