qiurui
/
uvgrtp-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
uvgrtp-base/docs/html/session_8hh_source.html

124 lines
10 KiB
HTML
Raw Normal View History

Add Doxygen documentation support Some of the API is still undocumented
2021-02-14 07:35:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvgRTP: include/session.hh 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">uvgRTP
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">session.hh</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="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;media_stream.hh&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;zrtp.hh&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span>uvg_rtp {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classuvg__rtp_1_1session.html"> 12</a></span>&#160; <span class="keyword">class </span><a class="code" href="classuvg__rtp_1_1session.html">session</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <a class="code" href="classuvg__rtp_1_1session.html">session</a>(std::string addr);</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classuvg__rtp_1_1session.html">session</a>(std::string remote_addr, std::string local_addr);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; ~<a class="code" href="classuvg__rtp_1_1session.html">session</a>();</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classuvg__rtp_1_1session.html#af083d3908e337ad5f58a2edc317e18d4"> 50</a></span>&#160; <a class="code" href="classuvg__rtp_1_1media__stream.html">uvg_rtp::media_stream</a> *<a class="code" href="classuvg__rtp_1_1session.html#af083d3908e337ad5f58a2edc317e18d4">create_stream</a>(<span class="keywordtype">int</span> src_port, <span class="keywordtype">int</span> dst_port, rtp_format_t fmt, <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classuvg__rtp_1_1session.html#a6a4419b42aeba70fb2a63b3cd87d663a"> 63</a></span>&#160; rtp_error_t <a class="code" href="classuvg__rtp_1_1session.html#a6a4419b42aeba70fb2a63b3cd87d663a">destroy_stream</a>(<a class="code" href="classuvg__rtp_1_1media__stream.html">uvg_rtp::media_stream</a> *stream);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">/* Get unique key of the session</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> * Used by context to index sessions */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; std::string&amp; get_key();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">/* Each RTP multimedia session shall have one ZRTP session from which all session are derived */</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; uvg_rtp::zrtp *zrtp_;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">/* Each RTP multimedia session is always IP-specific */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; std::string addr_;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">/* If user so wishes, the session can be bound to a certain interface */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::string laddr_;</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">/* All media streams of this session */</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; std::unordered_map&lt;uint32_t, uvg_rtp::media_stream *&gt; streams_;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::mutex session_mtx_;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; };</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</div>
<div class="ttc" id="aclassuvg__rtp_1_1media__stream_html"><div class="ttname"><a href="classuvg__rtp_1_1media__stream.html">uvg_rtp::media_stream</a></div><div class="ttdef"><b>Definition:</b> media_stream.hh:18</div></div>
<div class="ttc" id="aclassuvg__rtp_1_1session_html"><div class="ttname"><a href="classuvg__rtp_1_1session.html">uvg_rtp::session</a></div><div class="ttdef"><b>Definition:</b> session.hh:12</div></div>
<div class="ttc" id="aclassuvg__rtp_1_1session_html_a6a4419b42aeba70fb2a63b3cd87d663a"><div class="ttname"><a href="classuvg__rtp_1_1session.html#a6a4419b42aeba70fb2a63b3cd87d663a">uvg_rtp::session::destroy_stream</a></div><div class="ttdeci">rtp_error_t destroy_stream(uvg_rtp::media_stream *stream)</div><div class="ttdoc">Destroy a media stream.</div></div>
<div class="ttc" id="aclassuvg__rtp_1_1session_html_af083d3908e337ad5f58a2edc317e18d4"><div class="ttname"><a href="classuvg__rtp_1_1session.html#af083d3908e337ad5f58a2edc317e18d4">uvg_rtp::session::create_stream</a></div><div class="ttdeci">uvg_rtp::media_stream * create_stream(int src_port, int dst_port, rtp_format_t fmt, int flags)</div><div class="ttdoc">Create a bidirectional media stream for an RTP session.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>