blob: c4000ff6e8432c056e4e4c76db191d667d213a82 [file] [log] [blame] [edit]
<!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/html; charset=utf-8" />
<title>selenium.webdriver.remote.remote_connection &mdash; Selenium 2.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Selenium 2.0 documentation" href="../index.html" />
<link rel="up" title="Selenium Documentation" href="../api.html" />
<link rel="next" title="selenium.webdriver.remote.utils" href="selenium.webdriver.remote.utils.html" />
<link rel="prev" title="selenium.webdriver.remote.errorhandler" href="selenium.webdriver.remote.errorhandler.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="selenium.webdriver.remote.utils.html" title="selenium.webdriver.remote.utils"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="selenium.webdriver.remote.errorhandler.html" title="selenium.webdriver.remote.errorhandler"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Selenium 2.0 documentation</a> &raquo;</li>
<li><a href="../api.html" accesskey="U">Selenium Documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-selenium.webdriver.remote.remote_connection">
<span id="selenium-webdriver-remote-remote-connection"></span><h1>selenium.webdriver.remote.remote_connection<a class="headerlink" href="#module-selenium.webdriver.remote.remote_connection" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="selenium.webdriver.remote.remote_connection.HttpErrorHandler">
<em class="property">class </em><tt class="descclassname">selenium.webdriver.remote.remote_connection.</tt><tt class="descname">HttpErrorHandler</tt><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#HttpErrorHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.HttpErrorHandler" title="Permalink to this definition"></a></dt>
<dd><p>A custom HTTP error handler.</p>
<p>Used to return Response objects instead of raising an HTTPError exception.</p>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.HttpErrorHandler.http_error_default">
<tt class="descname">http_error_default</tt><big>(</big><em>req</em>, <em>fp</em>, <em>code</em>, <em>msg</em>, <em>headers</em><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#HttpErrorHandler.http_error_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.HttpErrorHandler.http_error_default" title="Permalink to this definition"></a></dt>
<dd><p>Default HTTP error handler.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Args :</th><td class="field-body"><ul class="first simple">
<li>req - The original Request object.</li>
<li>fp - The response body file object.</li>
<li>code - The HTTP status code returned by the server.</li>
<li>msg - The HTTP status message returned by the server.</li>
<li>headers - The response headers.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first last">A new Response object.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="selenium.webdriver.remote.remote_connection.RemoteConnection">
<em class="property">class </em><tt class="descclassname">selenium.webdriver.remote.remote_connection.</tt><tt class="descname">RemoteConnection</tt><big>(</big><em>remote_server_addr</em><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#RemoteConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.RemoteConnection" title="Permalink to this definition"></a></dt>
<dd><p>A connection with the Remote WebDriver server.</p>
<p>Communicates with the server using the WebDriver wire protocol:
<a class="reference external" href="http://code.google.com/p/selenium/wiki/JsonWireProtocol">http://code.google.com/p/selenium/wiki/JsonWireProtocol</a></p>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.RemoteConnection.execute">
<tt class="descname">execute</tt><big>(</big><em>command</em>, <em>params</em><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#RemoteConnection.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.RemoteConnection.execute" title="Permalink to this definition"></a></dt>
<dd><p>Send a command to the remote server.</p>
<p>Any path subtitutions required for the URL mapped to the command should be
included in the command parameters.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Args :</th><td class="field-body"><ul class="first last simple">
<li>command - A string specifying the command to execute.</li>
<li>params - A dictionary of named parameters to send with the command as
its JSON payload.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="selenium.webdriver.remote.remote_connection.Request">
<em class="property">class </em><tt class="descclassname">selenium.webdriver.remote.remote_connection.</tt><tt class="descname">Request</tt><big>(</big><em>url</em>, <em>data=None</em>, <em>method=None</em><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Request" title="Permalink to this definition"></a></dt>
<dd><p>Extends the urllib2.Request to support all HTTP request types.</p>
<p>Initialise a new HTTP request.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Args :</th><td class="field-body"><ul class="first last simple">
<li>url - String for the URL to send the request to.</li>
<li>data - Data to send with the request.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.Request.get_method">
<tt class="descname">get_method</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Request.get_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Request.get_method" title="Permalink to this definition"></a></dt>
<dd><p>Returns the HTTP method used by this request.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="selenium.webdriver.remote.remote_connection.Response">
<em class="property">class </em><tt class="descclassname">selenium.webdriver.remote.remote_connection.</tt><tt class="descname">Response</tt><big>(</big><em>fp</em>, <em>code</em>, <em>headers</em>, <em>url</em><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Response" title="Permalink to this definition"></a></dt>
<dd><p>Represents an HTTP response.</p>
<p>Initialise a new Response.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Args :</th><td class="field-body"><ul class="first last simple">
<li>fp - The response body file object.</li>
<li>code - The HTTP status code returned by the server.</li>
<li>headers - A dictionary of headers returned by the server.</li>
<li>url - URL of the retrieved resource represented by this Response.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.Response.close">
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Response.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Response.close" title="Permalink to this definition"></a></dt>
<dd><p>Close the response body file object.</p>
</dd></dl>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.Response.geturl">
<tt class="descname">geturl</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Response.geturl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Response.geturl" title="Permalink to this definition"></a></dt>
<dd><p>Returns the URL for the resource returned in this response.</p>
</dd></dl>
<dl class="method">
<dt id="selenium.webdriver.remote.remote_connection.Response.info">
<tt class="descname">info</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/selenium/webdriver/remote/remote_connection.html#Response.info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selenium.webdriver.remote.remote_connection.Response.info" title="Permalink to this definition"></a></dt>
<dd><p>Returns the response headers.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="selenium.webdriver.remote.errorhandler.html"
title="previous chapter">selenium.webdriver.remote.errorhandler</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="selenium.webdriver.remote.utils.html"
title="next chapter">selenium.webdriver.remote.utils</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/webdriver_remote/selenium.webdriver.remote.remote_connection.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="selenium.webdriver.remote.utils.html" title="selenium.webdriver.remote.utils"
>next</a> |</li>
<li class="right" >
<a href="selenium.webdriver.remote.errorhandler.html" title="selenium.webdriver.remote.errorhandler"
>previous</a> |</li>
<li><a href="../index.html">Selenium 2.0 documentation</a> &raquo;</li>
<li><a href="../api.html" >Selenium Documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, plightbo, simon.m.stewart, hbchai, jrhuggins, et al..
</div>
</body>
</html>