| <!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.5"/> |
| <title>Apache Mesos: src/linux/routing/filter/priority.hpp 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="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">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</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><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a18918b93668b435612395bbc2e8b82b.html">linux</a></li><li class="navelem"><a class="el" href="dir_cfcc063d6e54f12d25bee1413151fa14.html">routing</a></li><li class="navelem"><a class="el" href="dir_63ee66d07d6d294d2c7a805464cff705.html">filter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">priority.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="priority_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __LINUX_ROUTING_FILTER_PRIORITY_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __LINUX_ROUTING_FILTER_PRIORITY_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <stdint.h></span></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="keyword">namespace </span>routing {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceprocess.html#a3054d5443603436a6315f210a412cbbc">filter</a> {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Each filter on a link has a priority (a 16-bit integer). The</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// priority defines the order in which filters will be applied to each</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// packet. The lower the number, the higher the priority. In order to</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// deal with filters of different types, we split the priority into</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// two 8-bit parts: a primary part and a secondary part. When</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// comparing two priorities, their primary parts will be compared</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// first. If they have the same primary part, their secondary parts</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// will then be compared. Typically, the primary part is used to</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// define the preference order between different types of filters. For</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// example, a user may want ICMP packet filters to be always applied</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// first than IP packet filters. In that case, the user can assign</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// ICMP packet filters a higher priority in the primary part. If the</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// user wants to further define orders between filters of the same</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// type, they can use the secondary part.</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classrouting_1_1filter_1_1Priority.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classrouting_1_1filter_1_1Priority.html">Priority</a></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">public</span>:</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classrouting_1_1filter_1_1Priority.html#a2248e8e95c16b14b905d30a4bf6675ee"> 42</a></span>  <span class="keyword">explicit</span> <a class="code" href="classrouting_1_1filter_1_1Priority.html#a2248e8e95c16b14b905d30a4bf6675ee">Priority</a>(uint16_t priority)</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  primary = (uint8_t) (priority >> 8);</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  secondary = (uint8_t) priority;</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> </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classrouting_1_1filter_1_1Priority.html#a41a1939341586e23fe3260c5b94fcc59"> 48</a></span>  <a class="code" href="classrouting_1_1filter_1_1Priority.html#a41a1939341586e23fe3260c5b94fcc59">Priority</a>(uint8_t _primary, uint8_t _secondary)</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  : primary(_primary), secondary(_secondary) {}</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classrouting_1_1filter_1_1Priority.html#a3bc6a169579e1d68d5bdf21bfd2010a0"> 51</a></span>  uint16_t <span class="keyword">get</span>() <span class="keyword">const</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="keywordflow">return</span> (((uint16_t) primary) << 8) + secondary;</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uint8_t primary;</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  uint8_t secondary;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace filter {</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <span class="comment">// namespace routing {</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif // __LINUX_ROUTING_FILTER_PRIORITY_HPP__</span></div> |
| <div class="ttc" id="classrouting_1_1filter_1_1Priority_html"><div class="ttname"><a href="classrouting_1_1filter_1_1Priority.html">routing::filter::Priority</a></div><div class="ttdef"><b>Definition:</b> priority.hpp:39</div></div> |
| <div class="ttc" id="classrouting_1_1filter_1_1Priority_html_a2248e8e95c16b14b905d30a4bf6675ee"><div class="ttname"><a href="classrouting_1_1filter_1_1Priority.html#a2248e8e95c16b14b905d30a4bf6675ee">routing::filter::Priority::Priority</a></div><div class="ttdeci">Priority(uint16_t priority)</div><div class="ttdef"><b>Definition:</b> priority.hpp:42</div></div> |
| <div class="ttc" id="namespaceprocess_html_a3054d5443603436a6315f210a412cbbc"><div class="ttname"><a href="namespaceprocess.html#a3054d5443603436a6315f210a412cbbc">process::filter</a></div><div class="ttdeci">void filter(Filter *filter)</div></div> |
| <div class="ttc" id="classrouting_1_1filter_1_1Priority_html_a41a1939341586e23fe3260c5b94fcc59"><div class="ttname"><a href="classrouting_1_1filter_1_1Priority.html#a41a1939341586e23fe3260c5b94fcc59">routing::filter::Priority::Priority</a></div><div class="ttdeci">Priority(uint8_t _primary, uint8_t _secondary)</div><div class="ttdef"><b>Definition:</b> priority.hpp:48</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
