Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(274)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/experimental.socket.html

Issue 10790137: Adds socket.getInfo to the socket API (Closed) Base URL: http://git.chromium.org/chromium/src.git@master
Patch Set: Uses generated struct, updates docs slightly Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« chrome/common/extensions/api/experimental_socket.idl ('K') | « chrome/common/extensions/api/experimental_socket.idl ('k') | chrome/common/extensions/docs/extensions/experimental.socket.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 162 matching lines...) Expand 10 before | Expand all | Expand 10 after
173 <a href="#method-bind">bind</a> 173 <a href="#method-bind">bind</a>
174 </li><li> 174 </li><li>
175 <a href="#method-connect">connect</a> 175 <a href="#method-connect">connect</a>
176 </li><li> 176 </li><li>
177 <a href="#method-create">create</a> 177 <a href="#method-create">create</a>
178 </li><li> 178 </li><li>
179 <a href="#method-destroy">destroy</a> 179 <a href="#method-destroy">destroy</a>
180 </li><li> 180 </li><li>
181 <a href="#method-disconnect">disconnect</a> 181 <a href="#method-disconnect">disconnect</a>
182 </li><li> 182 </li><li>
183 <a href="#method-getInfo">getInfo</a>
184 </li><li>
183 <a href="#method-read">read</a> 185 <a href="#method-read">read</a>
184 </li><li> 186 </li><li>
185 <a href="#method-recvFrom">recvFrom</a> 187 <a href="#method-recvFrom">recvFrom</a>
186 </li><li> 188 </li><li>
187 <a href="#method-sendTo">sendTo</a> 189 <a href="#method-sendTo">sendTo</a>
188 </li><li> 190 </li><li>
189 <a href="#method-setKeepAlive">setKeepAlive</a> 191 <a href="#method-setKeepAlive">setKeepAlive</a>
190 </li><li> 192 </li><li>
191 <a href="#method-setNoDelay">setNoDelay</a> 193 <a href="#method-setNoDelay">setNoDelay</a>
192 </li><li> 194 </li><li>
(...skipping 21 matching lines...) Expand all
214 <ol> 216 <ol>
215 </ol> 217 </ol>
216 </li><li> 218 </li><li>
217 <a href="#type-experimental.socket.WriteInfo">experimental.socke t.WriteInfo</a> 219 <a href="#type-experimental.socket.WriteInfo">experimental.socke t.WriteInfo</a>
218 <ol> 220 <ol>
219 </ol> 221 </ol>
220 </li><li> 222 </li><li>
221 <a href="#type-experimental.socket.RecvFromInfo">experimental.so cket.RecvFromInfo</a> 223 <a href="#type-experimental.socket.RecvFromInfo">experimental.so cket.RecvFromInfo</a>
222 <ol> 224 <ol>
223 </ol> 225 </ol>
226 </li><li>
227 <a href="#type-experimental.socket.SocketInfo">experimental.sock et.SocketInfo</a>
228 <ol>
229 </ol>
224 </li> 230 </li>
225 </ol> 231 </ol>
226 </li> 232 </li>
227 </ol> 233 </ol>
228 </li> 234 </li>
229 </ol> 235 </ol>
230 </div> 236 </div>
231 <!-- /TABLE OF CONTENTS --> 237 <!-- /TABLE OF CONTENTS -->
232 <!-- Standard content lead-in for experimental API pages --> 238 <!-- Standard content lead-in for experimental API pages -->
233 <p id="classSummary"> 239 <p id="classSummary">
(...skipping 519 matching lines...) Expand 10 before | Expand all | Expand 10 after
753 </div> 759 </div>
754 </div> 760 </div>
755 </dl> 761 </dl>
756 <!-- RETURNS --> 762 <!-- RETURNS -->
757 <dl> 763 <dl>
758 </dl> 764 </dl>
759 <!-- CALLBACK --> 765 <!-- CALLBACK -->
760 <!-- MIN_VERSION --> 766 <!-- MIN_VERSION -->
761 </div> <!-- /description --> 767 </div> <!-- /description -->
762 </div><div class="apiItem"> 768 </div><div class="apiItem">
769 <a name="method-getInfo"></a> <!-- method-anchor -->
770 <h4>getInfo</h4>
771 <div class="summary">
772 <!-- Note: intentionally longer 80 columns -->
773 <span>chrome.experimental.socket.getInfo</span>(<span class="n ull"><span>integer</span>
774 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>function</span>
775 <var><span>GetInfoCallback</span></var></span>)</div>
776 <div class="description">
777 <p>Retrieve the state of the given socket.</p>
778 <!-- PARAMETERS -->
779 <h4>Parameters</h4>
780 <dl>
781 <div>
782 <div>
783 <dt>
784 <var>socketId</var>
785 <em>
786 <!-- TYPE -->
787 <div style="display:inline">
788 (
789 <span id="typeTemplate">
790 <span>
791 <span>integer</span>
792 </span>
793 </span>
794 )
795 </div>
796 </em>
797 </dt>
798 <dd>The socketId.</dd>
799 <!-- OBJECT PROPERTIES -->
800 <!-- OBJECT METHODS -->
801 <!-- OBJECT EVENT FIELDS -->
802 <!-- FUNCTION PARAMETERS -->
803 </div>
804 </div><div>
805 <div>
806 <dt>
807 <var>GetInfoCallback</var>
808 <em>
809 <!-- TYPE -->
810 <div style="display:inline">
811 (
812 <span id="typeTemplate">
813 <span>
814 <span>function</span>
815 </span>
816 </span>
817 )
818 </div>
819 </em>
820 </dt>
821 <dd class="todo">
822 Undocumented.
823 </dd>
824 <!-- OBJECT PROPERTIES -->
825 <!-- OBJECT METHODS -->
826 <!-- OBJECT EVENT FIELDS -->
827 <!-- FUNCTION PARAMETERS -->
828 <dd>
829 <div>
830 <h5>Parameters</h5>
831 <dl>
832 <div>
833 <div>
834 <dt>
835 <var>result</var>
836 <em>
837 <!-- TYPE -->
838 <div style="display:inline">
839 (
840 <span id="typeTemplate">
841 <span>
842 <a href="experimental.socket.html#type-experimental.sock et.SocketInfo">experimental.socket.SocketInfo</a>
843 </span>
844 </span>
845 )
846 </div>
847 </em>
848 </dt>
849 <dd class="todo">
850 Undocumented.
851 </dd>
852 <!-- OBJECT PROPERTIES -->
853 <!-- OBJECT METHODS -->
854 <!-- OBJECT EVENT FIELDS -->
855 <!-- FUNCTION PARAMETERS -->
856 </div>
857 </div>
858 </dl>
859 </div>
860 </dd>
861 </div>
862 </div>
863 </dl>
864 <!-- RETURNS -->
865 <dl>
866 </dl>
867 <!-- CALLBACK -->
868 <!-- MIN_VERSION -->
869 </div> <!-- /description -->
870 </div><div class="apiItem">
763 <a name="method-read"></a> <!-- method-anchor --> 871 <a name="method-read"></a> <!-- method-anchor -->
764 <h4>read</h4> 872 <h4>read</h4>
765 <div class="summary"> 873 <div class="summary">
766 <!-- Note: intentionally longer 80 columns --> 874 <!-- Note: intentionally longer 80 columns -->
767 <span>chrome.experimental.socket.read</span>(<span class="null "><span>integer</span> 875 <span>chrome.experimental.socket.read</span>(<span class="null "><span>integer</span>
768 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span> 876 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span>
769 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span> 877 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span>
770 <var><span>ReadCallback</span></var></span>)</div> 878 <var><span>ReadCallback</span></var></span>)</div>
771 <div class="description"> 879 <div class="description">
772 <p>Reads data from the given connected socket.</p> 880 <p>Reads data from the given connected socket.</p>
(...skipping 1191 matching lines...) Expand 10 before | Expand all | Expand 10 after
1964 <!-- OBJECT EVENT FIELDS --> 2072 <!-- OBJECT EVENT FIELDS -->
1965 <!-- FUNCTION PARAMETERS --> 2073 <!-- FUNCTION PARAMETERS -->
1966 </div> 2074 </div>
1967 </div> 2075 </div>
1968 </dl> 2076 </dl>
1969 </dd> 2077 </dd>
1970 <!-- OBJECT METHODS --> 2078 <!-- OBJECT METHODS -->
1971 <!-- OBJECT EVENT FIELDS --> 2079 <!-- OBJECT EVENT FIELDS -->
1972 <!-- FUNCTION PARAMETERS --> 2080 <!-- FUNCTION PARAMETERS -->
1973 </div> 2081 </div>
2082 </div><div class="apiItem">
2083 <a name="type-experimental.socket.SocketInfo"></a>
2084 <h4>experimental.socket.SocketInfo</h4>
2085 <div>
2086 <dt>
2087 <em>
2088 <!-- TYPE -->
2089 <div style="display:inline">
2090 (
2091 <span id="typeTemplate">
2092 <span>
2093 <span>object</span>
2094 </span>
2095 </span>
2096 )
2097 </div>
2098 </em>
2099 </dt>
2100 <dd class="todo">
2101 Undocumented.
2102 </dd>
2103 <!-- OBJECT PROPERTIES -->
2104 <dd>
2105 <dl>
2106 <div>
2107 <div>
2108 <dt>
2109 <var>connected</var>
2110 <em>
2111 <!-- TYPE -->
2112 <div style="display:inline">
2113 (
2114 <span id="typeTemplate">
2115 <span>
2116 <span>boolean</span>
2117 </span>
2118 </span>
2119 )
2120 </div>
2121 </em>
2122 </dt>
2123 <dd>Whether this socket is currently connected.</dd>
2124 <!-- OBJECT PROPERTIES -->
2125 <!-- OBJECT METHODS -->
2126 <!-- OBJECT EVENT FIELDS -->
2127 <!-- FUNCTION PARAMETERS -->
2128 </div>
2129 </div><div>
2130 <div>
2131 <dt>
2132 <var>localAddress</var>
2133 <em>
2134 <!-- TYPE -->
2135 <div style="display:inline">
2136 (
2137 <span class="optional">optional</span>
2138 <span id="typeTemplate">
2139 <span>
2140 <span>string</span>
2141 </span>
2142 </span>
2143 )
2144 </div>
2145 </em>
2146 </dt>
2147 <dd>If this socket is bound or connected, contains its local IPv4/6 ad dress.</dd>
2148 <!-- OBJECT PROPERTIES -->
2149 <!-- OBJECT METHODS -->
2150 <!-- OBJECT EVENT FIELDS -->
2151 <!-- FUNCTION PARAMETERS -->
2152 </div>
2153 </div><div>
2154 <div>
2155 <dt>
2156 <var>localPort</var>
2157 <em>
2158 <!-- TYPE -->
2159 <div style="display:inline">
2160 (
2161 <span class="optional">optional</span>
2162 <span id="typeTemplate">
2163 <span>
2164 <span>integer</span>
2165 </span>
2166 </span>
2167 )
2168 </div>
2169 </em>
2170 </dt>
2171 <dd>If this socket is bound or connected, contains its local port.</dd >
2172 <!-- OBJECT PROPERTIES -->
2173 <!-- OBJECT METHODS -->
2174 <!-- OBJECT EVENT FIELDS -->
2175 <!-- FUNCTION PARAMETERS -->
2176 </div>
2177 </div><div>
2178 <div>
2179 <dt>
2180 <var>peerAddress</var>
2181 <em>
2182 <!-- TYPE -->
2183 <div style="display:inline">
2184 (
2185 <span class="optional">optional</span>
2186 <span id="typeTemplate">
2187 <span>
2188 <span>string</span>
2189 </span>
2190 </span>
2191 )
2192 </div>
2193 </em>
2194 </dt>
2195 <dd>If this socket is connected, contains the IPv4/6 address of the pe er.</dd>
2196 <!-- OBJECT PROPERTIES -->
2197 <!-- OBJECT METHODS -->
2198 <!-- OBJECT EVENT FIELDS -->
2199 <!-- FUNCTION PARAMETERS -->
2200 </div>
2201 </div><div>
2202 <div>
2203 <dt>
2204 <var>peerPort</var>
2205 <em>
2206 <!-- TYPE -->
2207 <div style="display:inline">
2208 (
2209 <span class="optional">optional</span>
2210 <span id="typeTemplate">
2211 <span>
2212 <span>integer</span>
2213 </span>
2214 </span>
2215 )
2216 </div>
2217 </em>
2218 </dt>
2219 <dd>If this socket is connected, contains the port of the connected pe er.</dd>
2220 <!-- OBJECT PROPERTIES -->
2221 <!-- OBJECT METHODS -->
2222 <!-- OBJECT EVENT FIELDS -->
2223 <!-- FUNCTION PARAMETERS -->
2224 </div>
2225 </div><div>
2226 <div>
2227 <dt>
2228 <var>socketType</var>
2229 <em>
2230 <!-- TYPE -->
2231 <div style="display:inline">
2232 (
2233 <span id="typeTemplate">
2234 <span>
2235 <a href="experimental.socket.html#type-experimental.sock et.SocketType">experimental.socket.SocketType</a>
2236 </span>
2237 </span>
2238 )
2239 </div>
2240 </em>
2241 </dt>
2242 <dd>The type of the passed socket. This will be <code>tcp</code> or <c ode>udp</code>.</dd>
2243 <!-- OBJECT PROPERTIES -->
2244 <!-- OBJECT METHODS -->
2245 <!-- OBJECT EVENT FIELDS -->
2246 <!-- FUNCTION PARAMETERS -->
2247 </div>
2248 </div>
2249 </dl>
2250 </dd>
2251 <!-- OBJECT METHODS -->
2252 <!-- OBJECT EVENT FIELDS -->
2253 <!-- FUNCTION PARAMETERS -->
2254 </div>
1974 </div> <!-- /apiItem --> 2255 </div> <!-- /apiItem -->
1975 </div> <!-- /apiGroup --> 2256 </div> <!-- /apiGroup -->
1976 </div> <!-- /apiPage --> 2257 </div> <!-- /apiPage -->
1977 </div> <!-- /gc-pagecontent --> 2258 </div> <!-- /gc-pagecontent -->
1978 </div> <!-- /g-section --> 2259 </div> <!-- /g-section -->
1979 </div> <!-- /codesiteContent --> 2260 </div> <!-- /codesiteContent -->
1980 <div id="gc-footer" --=""> 2261 <div id="gc-footer" --="">
1981 <div class="text"> 2262 <div class="text">
1982 <p> 2263 <p>
1983 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 2264 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
(...skipping 29 matching lines...) Expand all
2013 _uff=0; 2294 _uff=0;
2014 urchinTracker(); 2295 urchinTracker();
2015 } 2296 }
2016 catch(e) {/* urchinTracker not available. */} 2297 catch(e) {/* urchinTracker not available. */}
2017 </script> 2298 </script>
2018 <!-- end analytics --> 2299 <!-- end analytics -->
2019 </div> 2300 </div>
2020 </div> <!-- /gc-footer --> 2301 </div> <!-- /gc-footer -->
2021 </div> <!-- /gc-container --> 2302 </div> <!-- /gc-container -->
2022 </body></html> 2303 </body></html>
OLDNEW
« chrome/common/extensions/api/experimental_socket.idl ('K') | « chrome/common/extensions/api/experimental_socket.idl ('k') | chrome/common/extensions/docs/extensions/experimental.socket.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698