83 lines
20 KiB
HTML
83 lines
20 KiB
HTML
<!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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Shaka Packager SDK: packager/app/job_manager.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/searchdata.js"></script>
|
|
<script type="text/javascript" src="../../search/search.js"></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 id="projectalign" 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.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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_bf7f1d16febc509cca62cff27fb88644.html">app</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">job_manager.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2017 Google Inc. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <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> <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> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef PACKAGER_APP_JOB_MANAGER_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_APP_JOB_MANAGER_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "packager/base/threading/simple_thread.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "packager/status.h"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>media {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>OriginHandler;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>SyncPointQueue;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// A job is a single line of work that is expected to run in parallel with</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// other jobs.</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="../../d0/d59/classshaka_1_1media_1_1Job.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a> : <span class="keyword">public</span> base::SimpleThread {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a>(<span class="keyword">const</span> std::string& name, std::shared_ptr<OriginHandler> work);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// Request that the job stops executing. This is only a request and</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// will not block. If you want to wait for the job to complete, use</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// |wait|.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> Cancel();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Get the current status of the job. If the job failed to initialize</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// or encountered an error during execution this will return the error.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a>& status()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> status_; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// If you want to wait for this job to complete, this will return the</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// WaitableEvent you can wait on.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  base::WaitableEvent* wait() { <span class="keywordflow">return</span> &wait_; }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a>(<span class="keyword">const</span> <a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d0/d59/classshaka_1_1media_1_1Job.html">Job</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> Run() <span class="keyword">override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::shared_ptr<OriginHandler> work_;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> status_;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  base::WaitableEvent wait_;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> };</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Similar to a thread pool, JobManager manages multiple jobs that are expected</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// to run in parallel. It can be used to register, run, and stop a batch of</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// jobs.</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// @param sync_points is an optional SyncPointQueue used to synchronize and</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// align cue points. JobManager cancels @a sync_points when any job</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// fails or is cancelled. It can be NULL.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">explicit</span> <a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a>(std::unique_ptr<SyncPointQueue> sync_points);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Create a new job entry by specifying the origin handler at the top of the</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// chain and a name for the thread. This will only register the job. To start</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// the job, you need to call |RunJobs|.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> Add(<span class="keyword">const</span> std::string& name, std::shared_ptr<OriginHandler> handler);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Initialize all registered jobs. If any job fails to initialize, this will</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// return the error and it will not be safe to call |RunJobs| as not all jobs</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// will be properly initialized.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> InitializeJobs();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// Run all registered jobs. Before calling this make sure that</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// |InitializedJobs| returned |Status::OK|. This call is blocking and will</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// block until all jobs exit.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> RunJobs();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// Ask all jobs to stop running. This call is non-blocking and can be used to</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// unblock a call to |RunJobs|.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> CancelJobs();</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">SyncPointQueue</a>* sync_points() { <span class="keywordflow">return</span> sync_points_.get(); }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a>(<span class="keyword">const</span> <a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">JobManager</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">struct </span>JobEntry {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  std::string name;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::shared_ptr<OriginHandler> worker;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// Stores Job entries for delayed construction of Job object.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  std::vector<JobEntry> job_entries_;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  std::vector<std::unique_ptr<Job>> jobs_;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// Stored in JobManager so JobManager can cancel |sync_points| when any job</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// fails or is cancelled.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  std::unique_ptr<SyncPointQueue> sync_points_;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> };</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <span class="comment">// namespace media</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> } <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif // PACKAGER_APP_JOB_MANAGER_H_</span></div><div class="ttc" id="namespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</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_1Job_html"><div class="ttname"><a href="../../d0/d59/classshaka_1_1media_1_1Job.html">shaka::media::Job</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/de6/job__manager_8h_source.html#l00024">job_manager.h:24</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1SyncPointQueue_html"><div class="ttname"><a href="../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html">shaka::media::SyncPointQueue</a></div><div class="ttdoc">A synchronized queue for cue points. </div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d5f/sync__point__queue_8h_source.html#l00020">sync_point_queue.h:20</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1JobManager_html"><div class="ttname"><a href="../../d3/d53/classshaka_1_1media_1_1JobManager.html">shaka::media::JobManager</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/de6/job__manager_8h_source.html#l00056">job_manager.h:56</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Aug 20 2018 10:46:49 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|