<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:39 CET 2013 -->
<title>Net.HttpRequest (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Net.HttpRequest (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Net.HttpRequest.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../index-all.html">Index
</a></li>
<li><a href="../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../com/badlogic/gdx/Net.HttpResponse.html" title="interface in com.badlogic.gdx"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/badlogic/gdx/Net.HttpRequest.html" target="_top">Frames
</a></li>
<li><a href="Net.HttpRequest.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx
</div>
<h2 title="Class Net.HttpRequest" class="title">Class Net.HttpRequest
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.Net.HttpRequest
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:
</dt>
<dd><a href="../../../com/badlogic/gdx/Net.html" title="interface in com.badlogic.gdx">Net
</a></dd>
</dl>
<hr>
<br>
<pre>public static class
<span class="strong">Net.HttpRequest
</span>
extends java.lang.Object
</pre>
<div class="block">Contains getters and setters for the following parameters:
<ul>
<li><strong>httpMethod:
</strong> GET or POST are most common, can use
<a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><code>HttpMethods
</code></a> for static
references
</li>
<li><strong>url:
</strong> the url
</li>
<li><strong>headers:
</strong> a map of the headers, setter can be called multiple times
</li>
<li><strong>timeout:
</strong> time spent trying to connect before giving up
</li>
<li><strong>content:
</strong> A string containing the data to be used when processing the HTTP request.
</li>
</ul>
Abstracts the concept of a HTTP Request:
<pre>
Map
<String, String> parameters = new HashMap
<String, String>();
parameters.put("user", "myuser");
HttpRequest httpGet = new HttpRequest(HttpMethods.Get);
httpGet.setUrl("http://somewhere.net");
httpGet.setContent(HttpParametersUtils.convertHttpParameters(parameters));
...
Gdx.net.sendHttpRequest (httpGet, new HttpResponseListener() {
public void handleHttpResponse(HttpResponse httpResponse) {
status = httpResponse.getResultAsString();
//do stuff here based on response
}
public void failed(Throwable t) {
status = "failed";
//do stuff here based on the failed attempt
}
});
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#Net.HttpRequest(java.lang.String)">Net.HttpRequest
</a></strong>(java.lang.String
httpMethod)
</code>
<div class="block">Creates a new HTTP request with the specified HTTP method, see
<a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><code>Net.HttpMethods
</code></a>.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getContent()">getContent
</a></strong>()
</code>
<div class="block">Returns the content string to be used for the HTTP request.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getContentLength()">getContentLength
</a></strong>()
</code>
<div class="block">Returns the content length in case content is a stream.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.InputStream
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getContentStream()">getContentStream
</a></strong>()
</code>
<div class="block">Returns the content stream.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Map
<java.lang.String,java.lang.String
></code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getHeaders()">getHeaders
</a></strong>()
</code>
<div class="block">Returns a Map
<String, String> with the headers of the HTTP request.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getMethod()">getMethod
</a></strong>()
</code>
<div class="block">Returns the HTTP method of the HttpRequest.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getTimeOut()">getTimeOut
</a></strong>()
</code>
<div class="block">Returns the timeOut of the HTTP request.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#getUrl()">getUrl
</a></strong>()
</code>
<div class="block">Returns the URL of the HTTP request.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#setContent(java.io.InputStream, long)">setContent
</a></strong>(java.io.InputStream
contentStream,
long
contentLength)
</code>
<div class="block">Sets the content as a stream to be used for a POST for example, to transmit custom data.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#setContent(java.lang.String)">setContent
</a></strong>(java.lang.String
content)
</code>
<div class="block">Sets the content to be used in the HTTP request.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#setHeader(java.lang.String, java.lang.String)">setHeader
</a></strong>(java.lang.String
name,
java.lang.String
value)
</code>
<div class="block">Sets a header to this HTTP request.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#setTimeOut(int)">setTimeOut
</a></strong>(int
timeOut)
</code>
<div class="block">Sets the time to wait for the HTTP request to be processed, use 0 block until it is done.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../com/badlogic/gdx/Net.HttpRequest.html#setUrl(java.lang.String)">setUrl
</a></strong>(java.lang.String
url)
</code>
<div class="block">Sets the URL of the HTTP request.
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="Net.HttpRequest(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Net.HttpRequest
</h4>
<pre>public
Net.HttpRequest(java.lang.String
httpMethod)
</pre>
<div class="block">Creates a new HTTP request with the specified HTTP method, see
<a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><code>Net.HttpMethods
</code></a>.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>httpMethod
</code> - This is the HTTP method for the request, see
<a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><code>Net.HttpMethods
</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="setUrl(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUrl
</h4>
<pre>public
void
setUrl(java.lang.String
url)
</pre>
<div class="block">Sets the URL of the HTTP request.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>url
</code> - The URL to set.
</dd></dl>
</li>
</ul>
<a name="setHeader(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeader
</h4>
<pre>public
void
setHeader(java.lang.String
name,
java.lang.String
value)
</pre>
<div class="block">Sets a header to this HTTP request. Headers definition could be found at
<a
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">HTTP/1.1: Header Field Definitions
</a> document.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>name
</code> - the name of the header.
</dd><dd><code>value
</code> - the value of the header.
</dd></dl>
</li>
</ul>
<a name="setContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent
</h4>
<pre>public
void
setContent(java.lang.String
content)
</pre>
<div class="block">Sets the content to be used in the HTTP request.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>content
</code> - A string encoded in the corresponding Content-Encoding set in the headers, with the data to send with the
HTTP request. For example, in case of HTTP GET, the content is used as the query string of the GET while on a
HTTP POST it is used to send the POST data.
</dd></dl>
</li>
</ul>
<a name="setContent(java.io.InputStream, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent
</h4>
<pre>public
void
setContent(java.io.InputStream
contentStream,
long
contentLength)
</pre>
<div class="block">Sets the content as a stream to be used for a POST for example, to transmit custom data.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>contentStream
</code> - The stream with the content data.
</dd></dl>
</li>
</ul>
<a name="setTimeOut(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeOut
</h4>
<pre>public
void
setTimeOut(int
timeOut)
</pre>
<div class="block">Sets the time to wait for the HTTP request to be processed, use 0 block until it is done. The timeout is used for both
the timeout when establishing TCP connection, and the timeout until the first byte of data is received.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>timeOut
</code> - the number of milliseconds to wait before giving up, 0 or negative to block until the operation is done
</dd></dl>
</li>
</ul>
<a name="getTimeOut()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeOut
</h4>
<pre>public
int
getTimeOut()
</pre>
<div class="block">Returns the timeOut of the HTTP request.
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the timeOut.
</dd></dl>
</li>
</ul>
<a name="getMethod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethod
</h4>
<pre>public
java.lang.String
getMethod()
</pre>
<div class="block">Returns the HTTP method of the HttpRequest.
</div>
</li>
</ul>
<a name="getUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrl
</h4>
<pre>public
java.lang.String
getUrl()
</pre>
<div class="block">Returns the URL of the HTTP request.
</div>
</li>
</ul>
<a name="getContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent
</h4>
<pre>public
java.lang.String
getContent()
</pre>
<div class="block">Returns the content string to be used for the HTTP request.
</div>
</li>
</ul>
<a name="getContentStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentStream
</h4>
<pre>public
java.io.InputStream
getContentStream()
</pre>
<div class="block">Returns the content stream.
</div>
</li>
</ul>
<a name="getContentLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentLength
</h4>
<pre>public
long
getContentLength()
</pre>
<div class="block">Returns the content length in case content is a stream.
</div>
</li>
</ul>
<a name="getHeaders()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHeaders
</h4>
<pre>public
java.util.Map
<java.lang.String,java.lang.String
> getHeaders()
</pre>
<div class="block">Returns a Map
<String, String> with the headers of the HTTP request.
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Net.HttpRequest.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../index-all.html">Index
</a></li>
<li><a href="../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/badlogic/gdx/Net.HttpMethods.html" title="interface in com.badlogic.gdx"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../com/badlogic/gdx/Net.HttpResponse.html" title="interface in com.badlogic.gdx"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/badlogic/gdx/Net.HttpRequest.html" target="_top">Frames
</a></li>
<li><a href="Net.HttpRequest.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>