cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache CXF Documentation > Asynchronous Client HTTP Transport
Date Wed, 26 Sep 2012 19:38:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/1/_/styles/combined.css?spaceKey=CXF20DOC&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Asynchronous+Client+HTTP+Transport">Asynchronous
Client HTTP Transport</a></h2>
    <h4>Page  <b>added</b> by             <a href="https://cwiki.apache.org/confluence/display/~dkulp">Daniel
Kulp</a>
    </h4>
         <br/>
    <div class="notificationGreySide">
         
<h1><a name="AsynchronousClientHTTPTransport-AsynchronousClientHTTPTransport"></a>Asynchronous
Client HTTP Transport</h1>

<p>By default, CXF uses a transport based on the in-JDK HttpURLConnection object to
perform HTTP requests.   The HttpURLConnection object uses a blocking model for all IO operations
which requires a per-thread execution model.   From a pure performance standpoint, this model
generally performs very well, but it does have problems scaling when many requests need to
be executed simultaneously.</p>

<p>Also, the JAX-WS specification allows for generation of asynchronous methods on generated
proxies as well as using asynchronous methods on the Dispatch objects.   These methods can
take an AsyncHandler object and return a polling Future object so applications do not have
to wait for the response.   With the HttpURLConnection based transport, CXF was forced to
consume a background thread for each outstanding request.</p>

<p>CXF also has an HTTP client transport that is based on the <a href="http://hc.apache.org/httpcomponents-asyncclient-dev/index.html"
class="external-link" rel="nofollow">Apache HTTP Components HttpAsyncClient</a> library.
  The HttpAsyncClient library uses a non-blocking IO model.  This allows many more requests
to be outstanding without consume extra background threads.   It also allows greater control
over things like Keep-Alive handling which is very difficult or impossible with the HttpURLConnection
based transport.   However, the non-blocking model does not perform quite as well as the blocking
model for pure synchronous request/response transactions.</p>

<p>By default, if the cxf-rt-transports-http-hc module is found on the classpath, CXF
will use the HttpAsyncClient based implementation for any Async calls, but will continue to
use the HttpURLConnection based transport for synchronous calls.   This allows a good balance
of performance for the common synchronous cases with scalability for the asynchronous cases.
 However, using a contextual property of "use.async.http.conduit" and set to true/false, you
can control whether the async or blocking version is used.   </p>


<h3><a name="AsynchronousClientHTTPTransport-Configuration"></a>Configuration
</h3>
<p>The Asynchronous HTTP Transport has several options that can set using Bus properties
or via the OSGi configuration services to control various aspects of the underlying Apache
HTTP Components HttpAsyncClient objects.</p>

<p>Settings related to the underlying TCP socket:</p>

<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.TCP_NODELAY </td>
<td class='confluenceTd'> The TCP_NODELAY for the socket.   Defaults to true.</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.SO_KEEPALIVE</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.SO_LINGER</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.SO_TIMEOUT</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
</tbody></table>
</div>


<p>Settings related to Keep-Alive connection management:</p>

<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.MAX_CONNECTIONS</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.MAX_PER_HOST_CONNECTIONS</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
</tbody></table>
</div>


<p>Settings related to Apache HttpAsyncClient threads and selectors:</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.ioThreadCount</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.interestOpQueued</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.selectInterval</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
</tbody></table>
</div>


<p>Setting to control which conduit is used</p>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>org.apache.cxf.transport.http.async.usePolicy</td>
<td class='confluenceTd'> ALWAYS, ASYNC_ONLY, NEVER.   </td>
</tr>
</tbody></table>
</div>


    </div>
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
       </div>
       <a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Asynchronous+Client+HTTP+Transport">View
Online</a>
              |
       <a href="https://cwiki.apache.org/confluence/display/CXF20DOC/Asynchronous+Client+HTTP+Transport?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
           </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message