aboutsummaryrefslogtreecommitdiffstats
path: root/libdash/include/IChunk.h
diff options
context:
space:
mode:
authorLuca Muscariello <lumuscar+fdio@cisco.com>2017-02-25 23:42:31 +0100
committerLuca Muscariello <lumuscar+fdio@cisco.com>2017-02-25 23:42:31 +0100
commit05c1a838c881ea502888659848d8792843b28718 (patch)
treecf0b05b58bd725a1eb6c80325ba986c63dea42aa /libdash/include/IChunk.h
parent9b30fc10fb1cbebe651e5a107e8ca5b24de54675 (diff)
Initial commit: video player - viper
Change-Id: Id5aa33598ce34659bad4a7a9ae5006bfb84f9bd1 Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
Diffstat (limited to 'libdash/include/IChunk.h')
-rw-r--r--libdash/include/IChunk.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/libdash/include/IChunk.h b/libdash/include/IChunk.h
new file mode 100644
index 00000000..76b3314b
--- /dev/null
+++ b/libdash/include/IChunk.h
@@ -0,0 +1,88 @@
+/**
+ * @class dash::network::IChunk
+ * @brief This interface is needed for accessing the information belonging to a dash::network::IChunk object
+ * @details Provides specific information of a chunk, e.g., URI, Hostname, Port, Path and optional Range that
+ * that are needed to download this chunk.
+ *
+ * @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 ICHUNK_H_
+#define ICHUNK_H_
+
+#include "config.h"
+#include "IHTTPTransaction.h"
+
+namespace dash
+{
+ namespace network
+ {
+ class IChunk
+ {
+ public:
+ virtual ~IChunk(){}
+
+ /**
+ * Returns a reference to a string that specifies the absolute URI to this chunk
+ * @return a reference to a string
+ */
+ virtual std::string& AbsoluteURI () = 0;
+
+ /**
+ * Returns a reference to a string that specifies the host of this chunk
+ * @return a reference to a string
+ */
+ virtual std::string& Host () = 0;
+
+ /**
+ * Returns an unsigned integer representing the port belonging to this chunk
+ * @return an unsigned integer
+ */
+ virtual size_t Port () = 0;
+
+ /**
+ * Returns a reference to a string that specifies the path to this chunk
+ * @return a reference to a string
+ */
+ virtual std::string& Path () = 0;
+
+ /**
+ * Returns a reference to a string that specifies the byte range belonging to this chunk
+ * @return a reference to a string
+ */
+ virtual std::string& Range () = 0;
+
+ /**
+ * Returns an unsigned integer representing the start byte of the byte range that belongs to this chunk
+ * @return an unsigned integer
+ */
+ virtual size_t StartByte () = 0;
+
+ /**
+ * Returns an unsigned integer representing the end byte of the byte range that belongs to this chunk
+ * @return an unsigned integer
+ */
+ virtual size_t EndByte () = 0;
+
+ /**
+ * Returns a bool value that represents whether this chunk has a byte range or not
+ * @return a bool value
+ */
+ virtual bool HasByteRange () = 0;
+
+ /**
+ * Returns the type of a <b>HTTP Request/Response Transaction</b> in <em>ISO/IEC 23009-1, Part 1, 2012</em>, annex D.4.3, Table D.2
+ * @return a dash::metrics::HTTPTransactionType
+ */
+ virtual dash::metrics::HTTPTransactionType GetType () = 0;
+ };
+ }
+}
+
+#endif /* ICHUNK_H_ */ \ No newline at end of file