chromium/src
0
Fork 0
Code Activity
Files
19310b23ee7c8544a2377fb05c93b1d97e3175f6
src/native_client_sdk/doc_generated/pepper_stable/c/ppb__websocket_8h.html
binji@chromium.org ad88ec0d62 [NaCl SDK Docs] PPAPI docs use a new template without a sidenav. 
This is not perfect, as some function names are still to long. But it improves
most of them.

I've also added the ability to specify the chromesite template to use from
within the .rst file.

BUG=374811
TEST=locally ran the server
R=kalman@chromium.org, sbc@chromium.org

Review URL: https://codereview.chromium.org/299753002

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@271937 0039d316-1c4b-4281-b951-d872f2087c98
2014-05-21 19:08:38 +00:00

101 lines
8.0 KiB
HTML
Raw Blame History

{{+bindTo:partials.standard_nacl_api}}
<h1>ppb_websocket.h File Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
<div>
<!-- Generated by Doxygen 1.7.6.1 -->
</div>
<!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
Include dependency graph for ppb_websocket.h:</div>
<div class="dyncontent">
<div class="center"><img src="ppb__websocket_8h__incl.png" border="0" usemap="#ppb__websocket_8h" alt="" /></div>
<map name="ppb__websocket_8h" id="ppb__websocket_8h">
</map>
</div>
</div><h2>
Data Structures</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___web_socket__1__0.html">PPB_WebSocket</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The <code>PPB_WebSocket</code> interface provides bi-directional, full-duplex, communications over a single TCP socket. <a href="struct_p_p_b___web_socket__1__0.html#details">More...</a><br /></td></tr>
</table><h2>
Defines</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ppb__websocket_8h.html#ad613dc4aff545f9e9885c415f1673107">PPB_WEBSOCKET_INTERFACE</a>&#160;&#160;&#160;&quot;PPB_WebSocket;1.0&quot;</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ppb__websocket_8h.html#a6d56a012c9350b4cc4e55b668d3fbe75">PPB_WEBSOCKET_INTERFACE</a>&#160;&#160;&#160;<a class="el" href="ppb__websocket_8h.html#ad613dc4aff545f9e9885c415f1673107">PPB_WEBSOCKET_INTERFACE</a></td></tr>
</table><h2>
Typedefs</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_p_p_b___web_socket__1__0.html">PPB_WebSocket</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___interfaces.html#gad0e152d14cefb0b480228f3fc7070faf">PPB_WebSocket</a></td></tr>
</table><h2>
Enumerations</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enums.html#gade61cdf6a7470769b571925694d91a89">PP_WebSocketReadyState</a> { <br />
&#160;&#160;<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a6c603b9df214e22d8b8202431866b26b">PP_WEBSOCKETREADYSTATE_INVALID</a> = -1,
<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a9ad491ea639e22b598d4e8cab463acd9">PP_WEBSOCKETREADYSTATE_CONNECTING</a> = 0,
<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a60f99e31f237d57df167d70e7c1ada7d">PP_WEBSOCKETREADYSTATE_OPEN</a> = 1,
<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a45ce2585ba8b200c6c02112098df6447">PP_WEBSOCKETREADYSTATE_CLOSING</a> = 2,
<br />
&#160;&#160;<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a43865a04fac402be4f589d2c7f9f02f4">PP_WEBSOCKETREADYSTATE_CLOSED</a> = 3
<br />
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enums.html#ga8458f33f09ecc56fcf486c60b844678d">PP_WebSocketCloseCode</a> { <br />
&#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678dace8b6cbd5ab6bdecc5762b8753702d47">PP_WEBSOCKETSTATUSCODE_NOT_SPECIFIED</a> = 1005,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daff82b3d825f09240d64479d5ae0a2e00">PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE</a> = 1000,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da9d8d5c41a6592a609324249950468fb4">PP_WEBSOCKETSTATUSCODE_GOING_AWAY</a> = 1001,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daf20b614979599d2a2ed79543618d6ef4">PP_WEBSOCKETSTATUSCODE_PROTOCOL_ERROR</a> = 1002,
<br />
&#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da4c63e46fd3e2a3b03fdcc577431f85ba">PP_WEBSOCKETSTATUSCODE_UNSUPPORTED_DATA</a> = 1003,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da75580d49b265525d2f8591be2aa02fe6">PP_WEBSOCKETSTATUSCODE_NO_STATUS_RECEIVED</a> = 1005,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678dad80b864c592819db0cb640d2b6e74a3f">PP_WEBSOCKETSTATUSCODE_ABNORMAL_CLOSURE</a> = 1006,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daea768048eaff4826bf06550d8da0dd42">PP_WEBSOCKETSTATUSCODE_INVALID_FRAME_PAYLOAD_DATA</a> = 1007,
<br />
&#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da4d4405b66c4b436c9bb31dfa4fa71523">PP_WEBSOCKETSTATUSCODE_POLICY_VIOLATION</a> = 1008,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da7c8d17601c982c62a933a3f721c049ef">PP_WEBSOCKETSTATUSCODE_MESSAGE_TOO_BIG</a> = 1009,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da5fae5457554a0cad877ccfa1d5636b8d">PP_WEBSOCKETSTATUSCODE_MANDATORY_EXTENSION</a> = 1010,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da7318b30a65ea442445e754453a73be81">PP_WEBSOCKETSTATUSCODE_INTERNAL_SERVER_ERROR</a> = 1011,
<br />
&#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da8aef76170a2836b651922555aa26348d">PP_WEBSOCKETSTATUSCODE_TLS_HANDSHAKE</a> = 1015,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da3a87714e399ce00177f60f85c9a993ba">PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN</a> = 3000,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da08c67e1fcd33b07c350be618d7d72403">PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX</a> = 3999,
<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da491bd1d7c9ada2c129062beb9eaeded1">PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN</a> = 4000,
<br />
&#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da242327b17ab568d625627236de721e5b">PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX</a> = 4999
<br />
}</td></tr>
</table><h2>
Variables</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enums.html#gade61cdf6a7470769b571925694d91a89">PP_WebSocketReadyState</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enums.html#ga8458f33f09ecc56fcf486c60b844678d">PP_WebSocketCloseCode</a></td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This file defines the <code>PPB_WebSocket</code> interface providing bi-directional, full-duplex, communications over a single TCP socket. </p>
</div><hr /><h2>Define Documentation</h2>
<a class="anchor" id="a6d56a012c9350b4cc4e55b668d3fbe75"></a><!-- doxytag: member="ppb_websocket.h::PPB_WEBSOCKET_INTERFACE" ref="a6d56a012c9350b4cc4e55b668d3fbe75" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="ppb__websocket_8h.html#a6d56a012c9350b4cc4e55b668d3fbe75">PPB_WEBSOCKET_INTERFACE</a>&#160;&#160;&#160;<a class="el" href="ppb__websocket_8h.html#ad613dc4aff545f9e9885c415f1673107">PPB_WEBSOCKET_INTERFACE</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad613dc4aff545f9e9885c415f1673107"></a><!-- doxytag: member="ppb_websocket.h::PPB_WEBSOCKET_INTERFACE" ref="ad613dc4aff545f9e9885c415f1673107" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="ppb__websocket_8h.html#ad613dc4aff545f9e9885c415f1673107">PPB_WEBSOCKET_INTERFACE</a>&#160;&#160;&#160;&quot;PPB_WebSocket;1.0&quot;</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}
View Git Blame Copy Permalink