native_client_sdk/doc_generated/pepper_dev/c/ppb__websocket_8h.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>ppb_websocket.h File Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9 </div>
  10 <!--header-->
  11 <div class="contents">
  12 <div class="textblock"><div class="dynheader">
  13 Include dependency graph for ppb_websocket.h:</div>
  14 <div class="dyncontent">
  15 <div class="center"><img src="ppb__websocket_8h__incl.png" border="0" usemap="#ppb__websocket_8h" alt="" /></div>
  16 <map name="ppb__websocket_8h" id="ppb__websocket_8h">
  17 </map>
  18 </div>
  19 </div><h2>
  20 Data Structures</h2><table class="memberdecls">
  21
  22 <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>
  23 <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>
  24 </table><h2>
  25 Defines</h2><table class="memberdecls">
  26 <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>
  27 <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>
  28 </table><h2>
  29 Typedefs</h2><table class="memberdecls">
  30 <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>
  31 </table><h2>
  32 Enumerations</h2><table class="memberdecls">
  33 <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 />
  34 &#160;&#160;<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a6c603b9df214e22d8b8202431866b26b">PP_WEBSOCKETREADYSTATE_INVALID</a> =  -1,
  35 <a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a9ad491ea639e22b598d4e8cab463acd9">PP_WEBSOCKETREADYSTATE_CONNECTING</a> =  0,
  36 <a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a60f99e31f237d57df167d70e7c1ada7d">PP_WEBSOCKETREADYSTATE_OPEN</a> =  1,
  37 <a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a45ce2585ba8b200c6c02112098df6447">PP_WEBSOCKETREADYSTATE_CLOSING</a> =  2,
  38 <br />
  39 &#160;&#160;<a class="el" href="group___enums.html#ggade61cdf6a7470769b571925694d91a89a43865a04fac402be4f589d2c7f9f02f4">PP_WEBSOCKETREADYSTATE_CLOSED</a> =  3
  40 <br />
  41  }</td></tr>
  42 <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 />
  43 &#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678dace8b6cbd5ab6bdecc5762b8753702d47">PP_WEBSOCKETSTATUSCODE_NOT_SPECIFIED</a> =  1005,
  44 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daff82b3d825f09240d64479d5ae0a2e00">PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE</a> =  1000,
  45 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da9d8d5c41a6592a609324249950468fb4">PP_WEBSOCKETSTATUSCODE_GOING_AWAY</a> =  1001,
  46 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daf20b614979599d2a2ed79543618d6ef4">PP_WEBSOCKETSTATUSCODE_PROTOCOL_ERROR</a> =  1002,
  47 <br />
  48 &#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da4c63e46fd3e2a3b03fdcc577431f85ba">PP_WEBSOCKETSTATUSCODE_UNSUPPORTED_DATA</a> =  1003,
  49 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da75580d49b265525d2f8591be2aa02fe6">PP_WEBSOCKETSTATUSCODE_NO_STATUS_RECEIVED</a> =  1005,
  50 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678dad80b864c592819db0cb640d2b6e74a3f">PP_WEBSOCKETSTATUSCODE_ABNORMAL_CLOSURE</a> =  1006,
  51 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678daea768048eaff4826bf06550d8da0dd42">PP_WEBSOCKETSTATUSCODE_INVALID_FRAME_PAYLOAD_DATA</a> =  1007,
  52 <br />
  53 &#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da4d4405b66c4b436c9bb31dfa4fa71523">PP_WEBSOCKETSTATUSCODE_POLICY_VIOLATION</a> =  1008,
  54 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da7c8d17601c982c62a933a3f721c049ef">PP_WEBSOCKETSTATUSCODE_MESSAGE_TOO_BIG</a> =  1009,
  55 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da5fae5457554a0cad877ccfa1d5636b8d">PP_WEBSOCKETSTATUSCODE_MANDATORY_EXTENSION</a> =  1010,
  56 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da7318b30a65ea442445e754453a73be81">PP_WEBSOCKETSTATUSCODE_INTERNAL_SERVER_ERROR</a> =  1011,
  57 <br />
  58 &#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da8aef76170a2836b651922555aa26348d">PP_WEBSOCKETSTATUSCODE_TLS_HANDSHAKE</a> =  1015,
  59 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da3a87714e399ce00177f60f85c9a993ba">PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN</a> =  3000,
  60 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da08c67e1fcd33b07c350be618d7d72403">PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX</a> =  3999,
  61 <a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da491bd1d7c9ada2c129062beb9eaeded1">PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN</a> =  4000,
  62 <br />
  63 &#160;&#160;<a class="el" href="group___enums.html#gga8458f33f09ecc56fcf486c60b844678da242327b17ab568d625627236de721e5b">PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX</a> =  4999
  64 <br />
  65  }</td></tr>
  66 </table><h2>
  67 Variables</h2><table class="memberdecls">
  68 <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>
  69 <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>
  70 </table>
  71 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  72 <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>
  73 </div><hr /><h2>Define Documentation</h2>
  74 <a class="anchor" id="a6d56a012c9350b4cc4e55b668d3fbe75"></a><!-- doxytag: member="ppb_websocket.h::PPB_WEBSOCKET_INTERFACE" ref="a6d56a012c9350b4cc4e55b668d3fbe75" args="" -->
  75 <div class="memitem">
  76 <div class="memproto">
  77 <table class="memname">
  78 <tr>
  79 <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>
  80 </tr>
  81 </table>
  82 </div>
  83 <div class="memdoc">
  84 </div>
  85 </div>
  86 <a class="anchor" id="ad613dc4aff545f9e9885c415f1673107"></a><!-- doxytag: member="ppb_websocket.h::PPB_WEBSOCKET_INTERFACE" ref="ad613dc4aff545f9e9885c415f1673107" args="" -->
  87 <div class="memitem">
  88 <div class="memproto">
  89 <table class="memname">
  90 <tr>
  91 <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>
  92 </tr>
  93 </table>
  94 </div>
  95 <div class="memdoc">
  96 </div>
  97 </div>
  98 </div><!-- contents -->
  99 </div>
 100 {{/partials.standard_nacl_api}}