111 lines
20 KiB
HTML
111 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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PxPvdTransport.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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&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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('PxPvdTransport_8h_source.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">PxPvdTransport.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="PxPvdTransport_8h.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">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Redistribution and use in source and binary forms, with or without</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// modification, are permitted provided that the following conditions</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// are met:</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// * Redistributions of source code must retain the above copyright</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// notice, this list of conditions and the following disclaimer.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// notice, this list of conditions and the following disclaimer in the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// documentation and/or other materials provided with the distribution.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// * Neither the name of NVIDIA CORPORATION nor the names of its</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// contributors may be used to endorse or promote products derived</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// from this software without specific prior written permission.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef PXPVDSDK_PXPVDTRANSPORT_H</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define PXPVDSDK_PXPVDTRANSPORT_H</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="PxErrors_8h.html">foundation/PxErrors.h</a>"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "<a class="code" href="PxFlags_8h.html">foundation/PxFlags.h</a>"</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="PxPvd_8h.html">pvd/PxPvd.h</a>"</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if !PX_DOXYGEN</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span><a class="code" href="namespacephysx.html">physx</a></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classPxPvdTransport.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classPxPvdTransport.html">PxPvdTransport</a></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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// connect, isConnected, disconnect, read, write, flush</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> connect() = 0;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> disconnect() = 0;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isConnected() = 0;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> write(<span class="keyword">const</span> uint8_t* inBytes, uint32_t inLength) = 0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">/*</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> lock this transport and return it</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <a class="code" href="classPxPvdTransport.html">PxPvdTransport</a>& lock() = 0;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">/*</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> unlock this transport</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> */</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> unlock() = 0;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() = 0;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> uint64_t getWrittenDataSize() = 0;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;</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="keyword">protected</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classPxPvdTransport.html#a969df5be18683a8805a24a6fa4699bc9"> 104</a></span>  <span class="keyword">virtual</span> <a class="code" href="classPxPvdTransport.html#a969df5be18683a8805a24a6fa4699bc9">~PxPvdTransport</a>()</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <a class="code" href="Pxc_8h.html#aea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="code" href="classPxPvdTransport.html">PxPvdTransport</a>* <a class="code" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <a class="code" href="group__pvd.html#gaba53e1ef15e10cade433600f8f7954c4">PxDefaultPvdSocketTransportCreate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutInMilliseconds);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <a class="code" href="Pxc_8h.html#aea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a> <a class="code" href="classPxPvdTransport.html">PxPvdTransport</a>* <a class="code" href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a> <a class="code" href="group__pvd.html#ga12ad7e982ca0e3d97f15c6bac4c479a2">PxDefaultPvdFileTransportCreate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#if !PX_DOXYGEN</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> } <span class="comment">// namespace physx</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif // PXPVDSDK_PXPVDTRANSPORT_H</span></div><div class="ttc" id="namespacephysx_html"><div class="ttname"><a href="namespacephysx.html">physx</a></div><div class="ttdef"><b>Definition:</b> GuContactBuffer.h:37</div></div>
|
|
<div class="ttc" id="PxPvd_8h_html"><div class="ttname"><a href="PxPvd_8h.html">PxPvd.h</a></div></div>
|
|
<div class="ttc" id="Pxc_8h_html_aea189596f11f07c586d4757cc67e8f7f"><div class="ttname"><a href="Pxc_8h.html#aea189596f11f07c586d4757cc67e8f7f">PX_C_EXPORT</a></div><div class="ttdeci">#define PX_C_EXPORT</div><div class="ttdef"><b>Definition:</b> Pxc.h:54</div></div>
|
|
<div class="ttc" id="group__foundation_html_ga65a319adb859941e5bd98575280b8d19"><div class="ttname"><a href="group__foundation.html#ga65a319adb859941e5bd98575280b8d19">PX_CALL_CONV</a></div><div class="ttdeci">#define PX_CALL_CONV</div><div class="ttdef"><b>Definition:</b> PxPreprocessor.h:315</div></div>
|
|
<div class="ttc" id="classPxPvdTransport_html"><div class="ttname"><a href="classPxPvdTransport.html">PxPvdTransport</a></div><div class="ttdoc">PxPvdTransport is an interface representing the data transport mechanism. This class defines all serv...</div><div class="ttdef"><b>Definition:</b> PxPvdTransport.h:53</div></div>
|
|
<div class="ttc" id="group__pvd_html_gaba53e1ef15e10cade433600f8f7954c4"><div class="ttname"><a href="group__pvd.html#gaba53e1ef15e10cade433600f8f7954c4">PxDefaultPvdSocketTransportCreate</a></div><div class="ttdeci">PX_C_EXPORT PxPvdTransport *PX_CALL_CONV PxDefaultPvdSocketTransportCreate(const char *host, int port, unsigned int timeoutInMilliseconds)</div><div class="ttdoc">Create a default socket transport. </div></div>
|
|
<div class="ttc" id="PxFlags_8h_html"><div class="ttname"><a href="PxFlags_8h.html">PxFlags.h</a></div></div>
|
|
<div class="ttc" id="group__pvd_html_ga12ad7e982ca0e3d97f15c6bac4c479a2"><div class="ttname"><a href="group__pvd.html#ga12ad7e982ca0e3d97f15c6bac4c479a2">PxDefaultPvdFileTransportCreate</a></div><div class="ttdeci">PX_C_EXPORT PxPvdTransport *PX_CALL_CONV PxDefaultPvdFileTransportCreate(const char *name)</div><div class="ttdoc">Create a default file transport. </div></div>
|
|
<div class="ttc" id="PxErrors_8h_html"><div class="ttname"><a href="PxErrors_8h.html">PxErrors.h</a></div></div>
|
|
<div class="ttc" id="classPxPvdTransport_html_a969df5be18683a8805a24a6fa4699bc9"><div class="ttname"><a href="classPxPvdTransport.html#a969df5be18683a8805a24a6fa4699bc9">PxPvdTransport::~PxPvdTransport</a></div><div class="ttdeci">virtual ~PxPvdTransport()</div><div class="ttdef"><b>Definition:</b> PxPvdTransport.h:104</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_713b4d6d20ce249967929ad234a3da6e.html">include</a></li><li class="navelem"><a class="el" href="dir_85cf7f34fcf7195bc46f1cd664eef0ce.html">pvd</a></li><li class="navelem"><a class="el" href="PxPvdTransport_8h.html">PxPvdTransport.h</a></li>
|
|
<li class="footer">Copyright © 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|