shaka-packager/docs/db/d71/http__key__fetcher_8h_sourc...

176 lines
20 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Shaka Packager SDK: packager/media/base/http_key_fetcher.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li><a href="../../annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_e3bda0bde998a4d5063328245b9909be.html">base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">http_key_fetcher.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2014 Google Inc. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// license that can be found in the LICENSE file or at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#ifndef MEDIA_BASE_HTTP_KEY_FETCHER_H_</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MEDIA_BASE_HTTP_KEY_FETCHER_H_</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/base/compiler_specific.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/media/base/key_fetcher.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>shaka {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>media {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html"> 26</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html">HttpKeyFetcher</a> : <span class="keyword">public</span> <a class="code" href="../../df/d66/classshaka_1_1media_1_1KeyFetcher.html">KeyFetcher</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a02561dcbbaf66152dce3ebd466810f15">HttpKeyFetcher</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a02561dcbbaf66152dce3ebd466810f15">HttpKeyFetcher</a>(uint32_t timeout_in_seconds);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; ~<a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html">HttpKeyFetcher</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#ab8e9b01fac00aa5dafb8983acd7a297b">FetchKeys</a>(<span class="keyword">const</span> std::string&amp; url,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> std::string&amp; request,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::string* response) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a6b5b2c193d6055ca49d2d6af2b2ac4cc">Get</a>(<span class="keyword">const</span> std::string&amp; url, std::string* response);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">virtual</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a31e904e2f802e5626c4420675c76d513">Post</a>(<span class="keyword">const</span> std::string&amp; url,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">const</span> std::string&amp; data,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::string* response);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a2ed8d56dddc800d76b57ed3674f01270"> 61</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a2ed8d56dddc800d76b57ed3674f01270">SetClientCertInfo</a>(<span class="keyword">const</span> std::string&amp; cert_file,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> std::string&amp; private_key_file,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> std::string&amp; private_key_password) {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; client_cert_file_ = cert_file;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; client_cert_private_key_file_ = private_key_file;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; client_cert_private_key_password_ = private_key_password;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a8420a100f8ff8e86c6bc95642ce29d0b"> 70</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a8420a100f8ff8e86c6bc95642ce29d0b">SetCaFile</a>(<span class="keyword">const</span> std::string&amp; ca_file) {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; ca_file_ = ca_file;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">enum</span> HttpMethod {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; GET,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; POST,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; PUT</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; };</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// Internal implementation of HTTP functions, e.g. Get and Post.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> FetchInternal(HttpMethod method, <span class="keyword">const</span> std::string&amp; url,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">const</span> std::string&amp; data, std::string* response);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> uint32_t timeout_in_seconds_;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; std::string ca_file_;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; std::string client_cert_file_;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; std::string client_cert_private_key_file_;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; std::string client_cert_private_key_password_;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a02561dcbbaf66152dce3ebd466810f15">HttpKeyFetcher</a>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;};</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;} <span class="comment">// namespace media</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="preprocessor">#endif // MEDIA_BASE_HTTP_KEY_FETCHER_H_</span></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html">shaka::media::HttpKeyFetcher</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/d71/http__key__fetcher_8h_source.html#l00026">http_key_fetcher.h:26</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_a8420a100f8ff8e86c6bc95642ce29d0b"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a8420a100f8ff8e86c6bc95642ce29d0b">shaka::media::HttpKeyFetcher::SetCaFile</a></div><div class="ttdeci">void SetCaFile(const std::string &amp;ca_file)</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d71/http__key__fetcher_8h_source.html#l00070">http_key_fetcher.h:70</a></div></div>
<div class="ttc" id="classshaka_1_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_a6b5b2c193d6055ca49d2d6af2b2ac4cc"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a6b5b2c193d6055ca49d2d6af2b2ac4cc">shaka::media::HttpKeyFetcher::Get</a></div><div class="ttdeci">virtual Status Get(const std::string &amp;url, std::string *response)</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d70/http__key__fetcher_8cc_source.html#l00090">http_key_fetcher.cc:90</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1KeyFetcher_html"><div class="ttname"><a href="../../df/d66/classshaka_1_1media_1_1KeyFetcher.html">shaka::media::KeyFetcher</a></div><div class="ttdoc">Base class for fetching keys from the license service. </div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d27/key__fetcher_8h_source.html#l00017">key_fetcher.h:17</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_a2ed8d56dddc800d76b57ed3674f01270"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a2ed8d56dddc800d76b57ed3674f01270">shaka::media::HttpKeyFetcher::SetClientCertInfo</a></div><div class="ttdeci">void SetClientCertInfo(const std::string &amp;cert_file, const std::string &amp;private_key_file, const std::string &amp;private_key_password)</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d71/http__key__fetcher_8h_source.html#l00061">http_key_fetcher.h:61</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_ab8e9b01fac00aa5dafb8983acd7a297b"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#ab8e9b01fac00aa5dafb8983acd7a297b">shaka::media::HttpKeyFetcher::FetchKeys</a></div><div class="ttdeci">Status FetchKeys(const std::string &amp;url, const std::string &amp;request, std::string *response) override</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d70/http__key__fetcher_8cc_source.html#l00084">http_key_fetcher.cc:84</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_a02561dcbbaf66152dce3ebd466810f15"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a02561dcbbaf66152dce3ebd466810f15">shaka::media::HttpKeyFetcher::HttpKeyFetcher</a></div><div class="ttdeci">HttpKeyFetcher()</div><div class="ttdoc">Creates a fetcher with no timeout. </div><div class="ttdef"><b>Definition:</b> <a href="../../de/d70/http__key__fetcher_8cc_source.html#l00077">http_key_fetcher.cc:77</a></div></div>
<div class="ttc" id="classshaka_1_1media_1_1HttpKeyFetcher_html_a31e904e2f802e5626c4420675c76d513"><div class="ttname"><a href="../../d7/de0/classshaka_1_1media_1_1HttpKeyFetcher.html#a31e904e2f802e5626c4420675c76d513">shaka::media::HttpKeyFetcher::Post</a></div><div class="ttdeci">virtual Status Post(const std::string &amp;url, const std::string &amp;data, std::string *response)</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d70/http__key__fetcher_8cc_source.html#l00094">http_key_fetcher.cc:94</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 11 2017 18:13:46 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>