SisMaker
/
ibrowse
1
0
Atdalīts 0
Kods Problēmas 0 Izmaiņu pieprasījumi 0 Projects 0 Laidieni 30 Vikivietne Aktivitāte
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
1 Revīzija
6 Atzari
1.1 MiB
Koks: cb7826c054
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no 'cb7826c054'
${ noResults }
ibrowse/doc/ibrowse.html

224 rindas
11 KiB
Neapstrādāts Parastais skats Vēsture

First version of ibrowse
pirms 20 gadiem
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html>
  3. <head>
  4. <title>Module ibrowse</title>
  5. <link rel="stylesheet" type="text/css" href="stylesheet.css">
  6. </head>
  7. <body bgcolor="white">
  8. <h1>Module ibrowse</h1>
  9. <ul><li>
  10. <a href="#index">Function index</a></li><li>
  11. <a href="#exported">Exported functions</a></li></ul>
  12. 

  13. <h2>Description</h2>
  14. The ibrowse application implements an HTTP 1.1 client. This
  15.   module implements the API of the HTTP client. There is one named
  16.   process called 'ibrowse' which acts as a load balancer. There is
  17.   one process to handle one TCP connection to a webserver
  18.   (implemented in the module ibrowse_http_client). Multiple connections to a
  19.   webserver are setup based on the settings for each webserver. The
  20.   ibrowse process also determines which connection to pipeline a
  21.   certain request on.  The functions to call are send_req/3,
  22.   send_req/4, send_req/5, send_req/6.
  23.  
  24.   <p>Here are a few sample invocations.</p>
  25.  
  26.   <code>
  27.   ibrowse:send_req("http://intranet/messenger/", [], get).
  28.   <br><br>
  29.  
  30.   ibrowse:send_req("http://www.google.com/", [], get, [],
  31.   		 [{proxy_user, "XXXXX"},
  32.   		  {proxy_password, "XXXXX"},
  33.   		  {proxy_host, "proxy"},
  34.   		  {proxy_port, 8080}], 1000).
  35.   <br><br>
  36.  
  37.  ibrowse:send_req("http://www.erlang.org/download/otp_src_R10B-3.tar.gz", [], get, [],
  38.   		 [{proxy_user, "XXXXX"},
  39.   		  {proxy_password, "XXXXX"},
  40.   		  {proxy_host, "proxy"},
  41.   		  {proxy_port, 8080},
  42.   		  {save_response_to_file, true}], 1000).
  43.   <br><br>
  44.  
  45.   ibrowse:set_dest("www.hotmail.com", 80, [{max_sessions, 10},
  46.   					    {max_pipeline_size, 1}]).
  47.   <br><br>
  48.  
  49.   ibrowse:send_req("http://www.erlang.org", [], head).
  50.  
  51.   <br><br>
  52.   ibrowse:send_req("http://www.sun.com", [], options).
  53.  
  54.   <br><br>
  55.   ibrowse:send_req("http://www.bbc.co.uk", [], trace).
  56.  
  57.   <br><br>
  58.   ibrowse:send_req("http://www.google.com", [], get, [],
  59.                     [{stream_to, self()}]).
  60.   </code>
  61.  
  62.   <p>A driver exists which implements URL encoding in C, but the
  63.   speed achieved using only erlang has been good enough, so the
  64.   driver isn't actually used.</p>
  65. 

  66. <h2><a name="index">Function Index</a></h2>
  67. 

  68. <table width="100%" border="1"><tr><th colspan="2" align="left">Exported Functions</th></tr>
  69. <tr><td><a href="#code_change-3">code_change/3</a></td><td/></tr>
  70. <tr><td><a href="#finished_async_request-0">finished_async_request/0</a></td><td>Internal export.</td></tr>
  71. <tr><td><a href="#handle_call-3">handle_call/3</a></td><td/></tr>
  72. <tr><td><a href="#handle_cast-2">handle_cast/2</a></td><td/></tr>
  73. <tr><td><a href="#handle_info-2">handle_info/2</a></td><td/></tr>
  74. <tr><td><a href="#init-1">init/1</a></td><td/></tr>
  75. <tr><td><a href="#reply-2">reply/2</a></td><td>Internal export.</td></tr>
  76. <tr><td><a href="#send_req-3">send_req/3</a></td><td>This is the basic function to send a HTTP request.</td></tr>
  77. <tr><td><a href="#send_req-4">send_req/4</a></td><td>Same as send_req/3.</td></tr>
  78. <tr><td><a href="#send_req-5">send_req/5</a></td><td>Same as send_req/4.</td></tr>
  79. <tr><td><a href="#send_req-6">send_req/6</a></td><td>Same as send_req/5.</td></tr>
  80. <tr><td><a href="#set_dest-3">set_dest/3</a></td><td>Sets options for a destination.</td></tr>
  81. <tr><td><a href="#shutting_down-0">shutting_down/0</a></td><td>Internal export.</td></tr>
  82. <tr><td><a href="#start-0">start/0</a></td><td/></tr>
  83. <tr><td><a href="#start_link-0">start_link/0</a></td><td/></tr>
  84. <tr><td><a href="#stop-0">stop/0</a></td><td/></tr>
  85. <tr><td><a href="#terminate-2">terminate/2</a></td><td/></tr>
  86. <tr><td><a href="#trace_off-0">trace_off/0</a></td><td>Turn tracing off for the ibrowse process.</td></tr>
  87. <tr><td><a href="#trace_off-2">trace_off/2</a></td><td>Turn tracing OFF for all connections to the specified HTTP
  88.   server.</td></tr>
  89. <tr><td><a href="#trace_on-0">trace_on/0</a></td><td>Turn tracing on for the ibrowse process.</td></tr>
  90. <tr><td><a href="#trace_on-2">trace_on/2</a></td><td>Turn tracing on for all connections to the specified HTTP
  91.   server.</td></tr>
  92. </table>
  93. 

  94. <h2><a name="exported">Exported Functions</a></h2>
  95. 

  96. <h3><a name="code_change-3">code_change/3</a></h3>
  97. 

  98. <p><code>code_change(Arg1, Arg2, Arg3) -> term()</code></p>
  99. <p> </p>
  100. 

  101. <h3><a name="finished_async_request-0">finished_async_request/0</a></h3>
  102. 

  103. <p><code>finished_async_request() -> term()</code></p>
  104. <p>Internal export. Called by a HTTP connection process to
  105.   indicate to the load balancing process (ibrowse) that an
  106.   asynchronous request has finished processing.</p>
  107. 

  108. <h3><a name="handle_call-3">handle_call/3</a></h3>
  109. 

  110. <p><code>handle_call(Arg1, Arg2, Arg3) -> term()</code></p>
  111. <p> </p>
  112. 

  113. <h3><a name="handle_cast-2">handle_cast/2</a></h3>
  114. 

  115. <p><code>handle_cast(Arg1, Arg2) -> term()</code></p>
  116. <p> </p>
  117. 

  118. <h3><a name="handle_info-2">handle_info/2</a></h3>
  119. 

  120. <p><code>handle_info(Arg1, Arg2) -> term()</code></p>
  121. <p> </p>
  122. 

  123. <h3><a name="init-1">init/1</a></h3>
  124. 

  125. <p><code>init(Arg1) -> term()</code></p>
  126. <p> </p>
  127. 

  128. <h3><a name="reply-2">reply/2</a></h3>
  129. 

  130. <p><code>reply(Arg1, Arg2) -> term()</code></p>
  131. <p>Internal export. Called by a HTTP connection process to
  132.   indicate to the load balancing process (ibrowse) that a synchronous
  133.   request has finished processing.</p>
  134. 

  135. <h3><a name="send_req-3">send_req/3</a></h3>
  136. 

  137. <p><code>send_req(Url::string(), Headers::<a href="#type-headerList">headerList()</a>, Method::<a href="#type-method">method()</a>) -> <a href="#type-response">response()</a><ul><li><a name="type-headerList">headerList()</a> = [{<a href="#type-header">header()</a>, <a href="#type-value">value()</a>}]</li><li><a name="type-header">header()</a> = atom() | string()</li><li><a name="type-value">value()</a> = term()</li><li><a name="type-method">method()</a> = get | post | head | options | put | delete | trace</li><li>Status = string()</li><li>ResponseHeaders = [<a href="#type-respHeader">respHeader()</a>]</li><li><a name="type-respHeader">respHeader()</a> = {<a href="#type-headerName">headerName()</a>, <a href="#type-headerValue">headerValue()</a>}</li><li><a name="type-headerName">headerName()</a> = string()</li><li><a name="type-headerValue">headerValue()</a> = string()</li><li><a name="type-response">response()</a> = {ok, Status, ResponseHeaders, ResponseBody} | {error, Reason}</li><li>ResponseBody = string()</li><li>Reason = term()</li></ul></code></p>
  138. <p>This is the basic function to send a HTTP request.
  139.   The Status return value indicates the HTTP status code returned by the webserver</p>
  140. 

  141. <h3><a name="send_req-4">send_req/4</a></h3>
  142. 

  143. <p><code>send_req(Url, Headers, Method::<a href="#type-method">method()</a>, Body::<a href="#type-body">body()</a>) -> <a href="#type-response">response()</a><ul><li><a name="type-body">body()</a> = [] | string() | binary()</li></ul></code></p>
  144. <p>Same as send_req/3.
  145.   If a list is specified for the body it has to be a flat list.</p>
  146. 

  147. <h3><a name="send_req-5">send_req/5</a></h3>
  148. 

  149. <p><code>send_req(Url::string(), Headers::<a href="#type-headerList">headerList()</a>, Method::<a href="#type-method">method()</a>, Body::<a href="#type-body">body()</a>, Options::<a href="#type-optionList">optionList()</a>) -> <a href="#type-response">response()</a><ul><li><a name="type-optionList">optionList()</a> = [<a href="#type-option">option()</a>]</li><li><a name="type-option">option()</a> = {max_sessions, integer()} | {max_pipeline_size, integer()} | {trace, <a href="#type-boolean">boolean()</a>} | {is_ssl, <a href="#type-boolean">boolean()</a>} | {ssl_options, [SSLOpt]} | {pool_name, atom()} | {proxy_host, string()} | {proxy_port, integer()} | {proxy_user, string()} | {proxy_password, string()} | {use_absolute_uri, <a href="#type-boolean">boolean()</a>} | {basic_auth, {<a href="#type-username">username()</a>, <a href="#type-password">password()</a>}} | {cookie, string()} | {content_length, integer()} | {content_type, string()} | {save_response_to_file, <a href="#type-boolean">boolean()</a>} | {stream_to, <a href="#type-process">process()</a>} | {http_vsn, {MajorVsn, MinorVsn}}</li><li><a name="type-process">process()</a> = pid() | atom()</li><li><a name="type-username">username()</a> = string()</li><li><a name="type-password">password()</a> = string()</li><li>SSLOpt = term()</li></ul></code></p>
  150. <p>Same as send_req/4.
  151.   For a description of SSL Options, look in the ssl manpage. If the
  152.   HTTP Version to use is not specified, the default is 1.1</p>
  153. 

  154. <h3><a name="send_req-6">send_req/6</a></h3>
  155. 

  156. <p><code>send_req(Url, Headers::<a href="#type-headerList">headerList()</a>, Method::<a href="#type-method">method()</a>, Body::<a href="#type-body">body()</a>, Options::<a href="#type-optionList">optionList()</a>, Timeout) -> <a href="#type-response">response()</a><ul><li>Timeout = integer() | infinity</li></ul></code></p>
  157. <p>Same as send_req/5.
  158.   All timeout values are in milliseconds.</p>
  159. 

  160. <h3><a name="set_dest-3">set_dest/3</a></h3>
  161. 

  162. <p><code>set_dest(Host::string(), Port::integer(), Opts::<a href="#type-opt_list">opt_list()</a>) -> ok<ul><li><a name="type-opt_list">opt_list()</a> = [opt]</li><li><a name="type-opt">opt()</a> = {max_sessions, integer()} | {max_pipeline_size, integer()} | {trace, <a href="#type-boolean">boolean()</a>}</li></ul></code></p>
  163. <p>Sets options for a destination. If the options have not been
  164.   set in the ibrowse.conf file, it can be set using this function
  165.   before sending the first request to the destination. If not,
  166.   defaults will be used. Entries in ibrowse.conf look like this.
  167.   <code><br>
  168.   {dest, Host, Port, MaxSess, MaxPipe, Options}.<br>
  169.   where <br>
  170.   Host = string(). "www.erlang.org" | "193.180.168.23"<br>
  171.   Port = integer()<br>
  172.   MaxSess = integer()<br>
  173.   MaxPipe = integer()<br>
  174.   Options = optionList() -- see options in send_req/5<br>
  175.   </code></p>
  176. 

  177. <h3><a name="shutting_down-0">shutting_down/0</a></h3>
  178. 

  179. <p><code>shutting_down() -> term()</code></p>
  180. <p>Internal export. Called by a HTTP connection process to
  181.   indicate to ibrowse that it is shutting down and further requests
  182.   should not be sent it's way.</p>
  183. 

  184. <h3><a name="start-0">start/0</a></h3>
  185. 

  186. <p><code>start() -> term()</code></p>
  187. <p> </p>
  188. 

  189. <h3><a name="start_link-0">start_link/0</a></h3>
  190. 

  191. <p><code>start_link() -> term()</code></p>
  192. <p> </p>
  193. 

  194. <h3><a name="stop-0">stop/0</a></h3>
  195. 

  196. <p><code>stop() -> term()</code></p>
  197. <p> </p>
  198. 

  199. <h3><a name="terminate-2">terminate/2</a></h3>
  200. 

  201. <p><code>terminate(Arg1, Arg2) -> term()</code></p>
  202. <p> </p>
  203. 

  204. <h3><a name="trace_off-0">trace_off/0</a></h3>
  205. 

  206. <p><code>trace_off() -> term()</code></p>
  207. <p>Turn tracing off for the ibrowse process</p>
  208. 

  209. <h3><a name="trace_off-2">trace_off/2</a></h3>
  210. 

  211. <p><code>trace_off(Host, Port) -> term()</code></p>
  212. <p>Turn tracing OFF for all connections to the specified HTTP
  213.   server.</p>
  214. 

  215. <h3><a name="trace_on-0">trace_on/0</a></h3>
  216. 

  217. <p><code>trace_on() -> term()</code></p>
  218. <p>Turn tracing on for the ibrowse process</p>
  219. 

  220. <h3><a name="trace_on-2">trace_on/2</a></h3>
  221. 

  222. <p><code>trace_on(Host, Port) -> term()<ul><li>Host = string()</li><li>Port = integer()</li></ul></code></p>
  223. <p>Turn tracing on for all connections to the specified HTTP
  224.   server. Host is whatever is specified as the domain name in the URL</p></body>
  225. </html>