Fit to 120 columns (in progress)

This commit is contained in:
Trustin Lee 2012-06-08 20:16:42 +09:00
parent 255a0721bd
commit 90a1bd6965
62 changed files with 412 additions and 393 deletions

View File

@ -39,11 +39,10 @@ import java.nio.charset.UnsupportedCharsetException;
* <h3>Random Access Indexing</h3> * <h3>Random Access Indexing</h3>
* *
* Just like an ordinary primitive byte array, {@link ChannelBuffer} uses * Just like an ordinary primitive byte array, {@link ChannelBuffer} uses
* <a href="http://en.wikipedia.org/wiki/Index_(information_technology)#Array_element_identifier">zero-based indexing</a>. * <a href="http://en.wikipedia.org/wiki/Zero-based_numbering">zero-based indexing</a>.
* It means the index of the first byte is always {@code 0} and the index of * It means the index of the first byte is always {@code 0} and the index of the last byte is
* the last byte is always {@link #capacity() capacity - 1}. For example, to * always {@link #capacity() capacity - 1}. For example, to iterate all bytes of a buffer, you
* iterate all bytes of a buffer, you can do the following, regardless of * can do the following, regardless of its internal implementation:
* its internal implementation:
* *
* <pre> * <pre>
* {@link ChannelBuffer} buffer = ...; * {@link ChannelBuffer} buffer = ...;

View File

@ -59,7 +59,8 @@ package org.jboss.netty.channel;
* <p> * <p>
* <strong>Caution:</strong> * <strong>Caution:</strong>
* <p> * <p>
* Use the *Later(..) methods of the {@link Channels} class if you want to send an upstream event from a {@link ChannelDownstreamHandler} otherwise you may run into threading issues. * Use the *Later(..) methods of the {@link Channels} class if you want to send an upstream event
* from a {@link ChannelDownstreamHandler} otherwise you may run into threading issues.
* *
* <h3>State management</h3> * <h3>State management</h3>
* *

View File

@ -71,7 +71,8 @@ import org.jboss.netty.channel.socket.ServerSocketChannel;
* <td>{@code "channelOpen"}</td> * <td>{@code "channelOpen"}</td>
* <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#OPEN OPEN}, value = {@code true})</td> * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#OPEN OPEN}, value = {@code true})</td>
* <td>a {@link Channel} is open, but not bound nor connected</td> * <td>a {@link Channel} is open, but not bound nor connected</td>
* <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong></td> * <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong></td>
* </tr> * </tr>
* <tr> * <tr>
* <td>{@code "channelClosed"}</td> * <td>{@code "channelClosed"}</td>
@ -82,7 +83,8 @@ import org.jboss.netty.channel.socket.ServerSocketChannel;
* <td>{@code "channelBound"}</td> * <td>{@code "channelBound"}</td>
* <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#BOUND BOUND}, value = {@link SocketAddress})</td> * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#BOUND BOUND}, value = {@link SocketAddress})</td>
* <td>a {@link Channel} is open and bound to a local address, but not connected.</td> * <td>a {@link Channel} is open and bound to a local address, but not connected.</td>
* <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong></td> * <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong></td>
* </tr> * </tr>
* <tr> * <tr>
* <td>{@code "channelUnbound"}</td> * <td>{@code "channelUnbound"}</td>
@ -91,9 +93,11 @@ import org.jboss.netty.channel.socket.ServerSocketChannel;
* </tr> * </tr>
* <tr> * <tr>
* <td>{@code "channelConnected"}</td> * <td>{@code "channelConnected"}</td>
* <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value = {@link SocketAddress})</td> * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value =
* {@link SocketAddress})</td>
* <td>a {@link Channel} is open, bound to a local address, and connected to a remote address</td> * <td>a {@link Channel} is open, bound to a local address, and connected to a remote address</td>
* <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong></td> * <td><strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong></td>
* </tr> * </tr>
* <tr> * <tr>
* <td>{@code "writeComplete"}</td> * <td>{@code "writeComplete"}</td>
@ -153,7 +157,8 @@ import org.jboss.netty.channel.socket.ServerSocketChannel;
* </tr> * </tr>
* <tr> * <tr>
* <td>{@code "connect"}</td> * <td>{@code "connect"}</td>
* <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value = {@link SocketAddress})</td> * <td>{@link ChannelStateEvent}<br/>(state = {@link ChannelState#CONNECTED CONNECTED}, value =
* {@link SocketAddress})</td>
* <td>Connect the {@link Channel} to the specified remote address.</td> * <td>Connect the {@link Channel} to the specified remote address.</td>
* </tr> * </tr>
* <tr> * <tr>

View File

@ -142,7 +142,7 @@ import org.jboss.netty.channel.group.ChannelGroup;
* <pre> * <pre>
* public final class DataServerState { * public final class DataServerState {
* *
* <b>public static final {@link ChannelLocal}&lt;Boolean&gt; loggedIn = new {@link ChannelLocal}&lt;Boolean&gt;() { * <b>public static final {@link ChannelLocal}&lt;Boolean&gt; loggedIn = new {@link ChannelLocal}&lt;&gt;() {
* protected Boolean initialValue(Channel channel) { * protected Boolean initialValue(Channel channel) {
* return false; * return false;
* } * }

View File

@ -48,7 +48,8 @@ public class ChannelLocal<T> implements Iterable<Entry<Channel, T>> {
private final boolean removeOnClose; private final boolean removeOnClose;
/** /**
* Creates a {@link Channel} local variable by calling {@link #ChannelLocal(boolean)} with <code>false</code> as parameter * Creates a {@link Channel} local variable by calling {@link #ChannelLocal(boolean)} with
* <code>false</code> as parameter
*/ */
public ChannelLocal() { public ChannelLocal() {
this(false); this(false);
@ -57,7 +58,8 @@ public class ChannelLocal<T> implements Iterable<Entry<Channel, T>> {
/** /**
* Creates a {@link Channel} local variable. * Creates a {@link Channel} local variable.
* *
* @param removeOnClose if <code>true</code> the {@link ChannelLocal} will remove a {@link Channel} from it own once the {@link Channel} was closed. * @param removeOnClose if <code>true</code> the {@link ChannelLocal} will remove a
* {@link Channel} from it own once the {@link Channel} was closed.
*/ */
public ChannelLocal(boolean removeOnClose) { public ChannelLocal(boolean removeOnClose) {
this.removeOnClose = removeOnClose; this.removeOnClose = removeOnClose;

View File

@ -168,7 +168,8 @@ import org.jboss.netty.handler.ssl.SslHandler;
* {@link ChannelPipeline} pipeline = {@link Channels#pipeline() Channels.pipeline()}; * {@link ChannelPipeline} pipeline = {@link Channels#pipeline() Channels.pipeline()};
* pipeline.addLast("decoder", new MyProtocolDecoder()); * pipeline.addLast("decoder", new MyProtocolDecoder());
* pipeline.addLast("encoder", new MyProtocolEncoder()); * pipeline.addLast("encoder", new MyProtocolEncoder());
* pipeline.addLast("executor", new {@link ExecutionHandler}(new {@link OrderedMemoryAwareThreadPoolExecutor}(16, 1048576, 1048576))); * pipeline.addLast("executor", new {@link ExecutionHandler}(
* new {@link OrderedMemoryAwareThreadPoolExecutor}(16, 1048576, 1048576)));
* pipeline.addLast("handler", new MyBusinessLogicHandler()); * pipeline.addLast("handler", new MyBusinessLogicHandler());
* </pre> * </pre>
* *

View File

@ -52,7 +52,8 @@ import java.net.SocketAddress;
* <p> * <p>
* <strong>Caution:</strong> * <strong>Caution:</strong>
* <p> * <p>
* Use the *Later(..) methods of the {@link Channels} class if you want to send an upstream event from a {@link ChannelDownstreamHandler} otherwise you may run into threading issues. * Use the *Later(..) methods of the {@link Channels} class if you want to send an upstream event
* from a {@link ChannelDownstreamHandler} otherwise you may run into threading issues.
* *
*/ */
public class SimpleChannelDownstreamHandler implements ChannelDownstreamHandler { public class SimpleChannelDownstreamHandler implements ChannelDownstreamHandler {

View File

@ -147,7 +147,8 @@ public class SimpleChannelUpstreamHandler implements ChannelUpstreamHandler {
* Invoked when a {@link Channel} is open, but not bound nor connected. * Invoked when a {@link Channel} is open, but not bound nor connected.
* <br/> * <br/>
* *
* <strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong> * <strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong>
*/ */
public void channelOpen( public void channelOpen(
ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {
@ -159,7 +160,8 @@ public class SimpleChannelUpstreamHandler implements ChannelUpstreamHandler {
* but not connected. * but not connected.
* <br/> * <br/>
* *
* <strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong> * <strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong>
*/ */
public void channelBound( public void channelBound(
ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {
@ -171,7 +173,8 @@ public class SimpleChannelUpstreamHandler implements ChannelUpstreamHandler {
* connected to a remote address. * connected to a remote address.
* <br/> * <br/>
* *
* <strong>Be aware that this event is fired from within the Boss-Thread so you should not execute any heavy operation in there as it will block the dispatching to other workers!</strong> * <strong>Be aware that this event is fired from within the Boss-Thread so you should not
* execute any heavy operation in there as it will block the dispatching to other workers!</strong>
*/ */
public void channelConnected( public void channelConnected(
ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {

View File

@ -138,7 +138,8 @@ public class HttpStaticFileServerHandler extends SimpleChannelUpstreamHandler {
SimpleDateFormat dateFormatter = new SimpleDateFormat(HTTP_DATE_FORMAT, Locale.US); SimpleDateFormat dateFormatter = new SimpleDateFormat(HTTP_DATE_FORMAT, Locale.US);
Date ifModifiedSinceDate = dateFormatter.parse(ifModifiedSince); Date ifModifiedSinceDate = dateFormatter.parse(ifModifiedSince);
// Only compare up to the second because the datetime format we send to the client does not have milliseconds // Only compare up to the second because the datetime format we send to the client does
// not have milliseconds
long ifModifiedSinceDateSeconds = ifModifiedSinceDate.getTime() / 1000; long ifModifiedSinceDateSeconds = ifModifiedSinceDate.getTime() / 1000;
long fileLastModifiedSeconds = file.lastModified() / 1000; long fileLastModifiedSeconds = file.lastModified() / 1000;
if (ifModifiedSinceDateSeconds == fileLastModifiedSeconds) { if (ifModifiedSinceDateSeconds == fileLastModifiedSeconds) {
@ -297,7 +298,8 @@ public class HttpStaticFileServerHandler extends SimpleChannelUpstreamHandler {
time.add(Calendar.SECOND, HTTP_CACHE_SECONDS); time.add(Calendar.SECOND, HTTP_CACHE_SECONDS);
response.setHeader(HttpHeaders.Names.EXPIRES, dateFormatter.format(time.getTime())); response.setHeader(HttpHeaders.Names.EXPIRES, dateFormatter.format(time.getTime()));
response.setHeader(HttpHeaders.Names.CACHE_CONTROL, "private, max-age=" + HTTP_CACHE_SECONDS); response.setHeader(HttpHeaders.Names.CACHE_CONTROL, "private, max-age=" + HTTP_CACHE_SECONDS);
response.setHeader(HttpHeaders.Names.LAST_MODIFIED, dateFormatter.format(new Date(fileToCache.lastModified()))); response.setHeader(
HttpHeaders.Names.LAST_MODIFIED, dateFormatter.format(new Date(fileToCache.lastModified())));
} }
/** /**

View File

@ -132,7 +132,8 @@ public class HttpSnoopServerHandler extends SimpleChannelUpstreamHandler {
if (keepAlive) { if (keepAlive) {
// Add 'Content-Length' header only for a keep-alive connection. // Add 'Content-Length' header only for a keep-alive connection.
response.setHeader(CONTENT_LENGTH, response.getContent().readableBytes()); response.setHeader(CONTENT_LENGTH, response.getContent().readableBytes());
// Add keep alive header as per http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01.html#Connection // Add keep alive header as per:
// - http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01.html#Connection
response.setHeader(CONNECTION, HttpHeaders.Values.KEEP_ALIVE); response.setHeader(CONNECTION, HttpHeaders.Values.KEEP_ALIVE);
} }

View File

@ -430,7 +430,8 @@ public class HttpUploadServerHandler extends SimpleChannelUpstreamHandler {
responseContent responseContent
.append("<tr><td>Fill with value: <br> <textarea name=\"thirdinfo\" cols=40 rows=10></textarea>"); .append("<tr><td>Fill with value: <br> <textarea name=\"thirdinfo\" cols=40 rows=10></textarea>");
responseContent responseContent
.append("<tr><td>Fill with file (only file name will be transmitted): <br> <input type=file name=\"myfile\">"); .append("<tr><td>Fill with file (only file name will be transmitted): <br> " +
"<input type=file name=\"myfile\">");
responseContent.append("</td></tr>"); responseContent.append("</td></tr>");
responseContent responseContent
.append("<tr><td><INPUT TYPE=\"submit\" NAME=\"Send\" VALUE=\"Send\"></INPUT></td>"); .append("<tr><td><INPUT TYPE=\"submit\" NAME=\"Send\" VALUE=\"Send\"></INPUT></td>");

View File

@ -27,67 +27,50 @@ public final class WebSocketServerIndexPage {
private static final String NEWLINE = "\r\n"; private static final String NEWLINE = "\r\n";
public static ChannelBuffer getContent(String webSocketLocation) { public static ChannelBuffer getContent(String webSocketLocation) {
return ChannelBuffers return ChannelBuffers.copiedBuffer(
.copiedBuffer( "<html><head><title>Web Socket Test</title></head>" + NEWLINE +
"<html><head><title>Web Socket Test</title></head>" "<body>" + NEWLINE +
+ NEWLINE "<script type=\"text/javascript\">" + NEWLINE +
+ "<body>" "var socket;" + NEWLINE +
+ NEWLINE "if (!window.WebSocket) {" + NEWLINE +
+ "<script type=\"text/javascript\">" " window.WebSocket = window.MozWebSocket;" + NEWLINE +
+ NEWLINE "}" + NEWLINE +
+ "var socket;" "if (window.WebSocket) {" + NEWLINE +
+ NEWLINE " socket = new WebSocket(\"" + webSocketLocation + "\");" + NEWLINE +
+ "if (!window.WebSocket) {" " socket.onmessage = function(event) {" + NEWLINE +
+ NEWLINE " var ta = document.getElementById('responseText');" + NEWLINE +
+ " window.WebSocket = window.MozWebSocket;" " ta.value = ta.value + '\\n' + event.data" + NEWLINE +
+ NEWLINE " };" + NEWLINE +
+ "}" " socket.onopen = function(event) {" + NEWLINE +
+ NEWLINE " var ta = document.getElementById('responseText');" + NEWLINE +
+ "if (window.WebSocket) {" " ta.value = \"Web Socket opened!\";" + NEWLINE +
+ NEWLINE " };" + NEWLINE +
+ " socket = new WebSocket(\"" " socket.onclose = function(event) {" + NEWLINE +
+ webSocketLocation " var ta = document.getElementById('responseText');" + NEWLINE +
+ "\");" " ta.value = ta.value + \"Web Socket closed\"; " + NEWLINE +
+ NEWLINE " };" + NEWLINE +
+ " socket.onmessage = function(event) { var ta = document.getElementById('responseText'); ta.value = ta.value + '\\n' + event.data };" "} else {" + NEWLINE +
+ NEWLINE " alert(\"Your browser does not support Web Socket.\");" + NEWLINE +
+ " socket.onopen = function(event) { var ta = document.getElementById('responseText'); ta.value = \"Web Socket opened!\"; };" "}" + NEWLINE +
+ NEWLINE NEWLINE +
+ " socket.onclose = function(event) { var ta = document.getElementById('responseText'); ta.value = ta.value + \"Web Socket closed\"; };" "function send(message) {" + NEWLINE +
+ NEWLINE " if (!window.WebSocket) { return; }" + NEWLINE +
+ "} else {" " if (socket.readyState == WebSocket.OPEN) {" + NEWLINE +
+ NEWLINE " socket.send(message);" + NEWLINE +
+ " alert(\"Your browser does not support Web Socket.\");" " } else {" + NEWLINE +
+ NEWLINE " alert(\"The socket is not open.\");" + NEWLINE +
+ "}" " }" + NEWLINE +
+ NEWLINE "}" + NEWLINE +
+ NEWLINE "</script>" + NEWLINE +
+ "function send(message) {" "<form onsubmit=\"return false;\">" + NEWLINE +
+ NEWLINE "<input type=\"text\" name=\"message\" value=\"Hello, World!\"/>" +
+ " if (!window.WebSocket) { return; }" "<input type=\"button\" value=\"Send Web Socket Data\"" + NEWLINE +
+ NEWLINE " onclick=\"send(this.form.message.value)\" />" + NEWLINE +
+ " if (socket.readyState == WebSocket.OPEN) {" "<h3>Output</h3>" + NEWLINE +
+ NEWLINE "<textarea id=\"responseText\" style=\"width:500px;height:300px;\"></textarea>" + NEWLINE +
+ " socket.send(message);" "</form>" + NEWLINE +
+ NEWLINE "</body>" + NEWLINE +
+ " } else {" "</html>" + NEWLINE, CharsetUtil.US_ASCII);
+ NEWLINE
+ " alert(\"The socket is not open.\");"
+ NEWLINE
+ " }"
+ NEWLINE
+ "}"
+ NEWLINE
+ "</script>"
+ NEWLINE
+ "<form onsubmit=\"return false;\">"
+ NEWLINE
+ "<input type=\"text\" name=\"message\" value=\"Hello, World!\"/>"
+ "<input type=\"button\" value=\"Send Web Socket Data\" onclick=\"send(this.form.message.value)\" />"
+ NEWLINE + "<h3>Output</h3>" + NEWLINE
+ "<textarea id=\"responseText\" style=\"width: 500px; height:300px;\"></textarea>"
+ NEWLINE + "</form>" + NEWLINE + "</body>" + NEWLINE + "</html>" + NEWLINE,
CharsetUtil.US_ASCII);
} }
private WebSocketServerIndexPage() { private WebSocketServerIndexPage() {

View File

@ -29,6 +29,7 @@ import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.channel.ExceptionEvent; import org.jboss.netty.channel.ExceptionEvent;
import org.jboss.netty.channel.MessageEvent; import org.jboss.netty.channel.MessageEvent;
import org.jboss.netty.channel.SimpleChannelUpstreamHandler; import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
import org.jboss.netty.example.http.websocketx.server.WebSocketServerIndexPage;
import org.jboss.netty.handler.codec.http.DefaultHttpResponse; import org.jboss.netty.handler.codec.http.DefaultHttpResponse;
import org.jboss.netty.handler.codec.http.HttpHeaders; import org.jboss.netty.handler.codec.http.HttpHeaders;
import org.jboss.netty.handler.codec.http.HttpRequest; import org.jboss.netty.handler.codec.http.HttpRequest;
@ -75,7 +76,7 @@ public class WebSocketSslServerHandler extends SimpleChannelUpstreamHandler {
if (req.getUri().equals("/")) { if (req.getUri().equals("/")) {
HttpResponse res = new DefaultHttpResponse(HTTP_1_1, OK); HttpResponse res = new DefaultHttpResponse(HTTP_1_1, OK);
ChannelBuffer content = WebSocketSslServerIndexPage.getContent(getWebSocketLocation(req)); ChannelBuffer content = WebSocketServerIndexPage.getContent(getWebSocketLocation(req));
res.setHeader(CONTENT_TYPE, "text/html; charset=UTF-8"); res.setHeader(CONTENT_TYPE, "text/html; charset=UTF-8");
setContentLength(res, content.readableBytes()); setContentLength(res, content.readableBytes());

View File

@ -1,96 +0,0 @@
/*
* Copyright 2012 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package org.jboss.netty.example.http.websocketx.sslserver;
import org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.buffer.ChannelBuffers;
import org.jboss.netty.util.CharsetUtil;
/**
* Generates the demo HTML page which is served at http://localhost:8080/
*/
public final class WebSocketSslServerIndexPage {
private static final String NEWLINE = "\r\n";
public static ChannelBuffer getContent(String webSocketLocation) {
return ChannelBuffers
.copiedBuffer(
"<html><head><title>Web Socket Test</title></head>"
+ NEWLINE
+ "<body>"
+ NEWLINE
+ "<script type=\"text/javascript\">"
+ NEWLINE
+ "var socket;"
+ NEWLINE
+ "if (!window.WebSocket) {"
+ NEWLINE
+ " window.WebSocket = window.MozWebSocket;"
+ NEWLINE
+ "}"
+ NEWLINE
+ "if (window.WebSocket) {"
+ NEWLINE
+ " socket = new WebSocket(\""
+ webSocketLocation
+ "\");"
+ NEWLINE
+ " socket.onmessage = function(event) { var ta = document.getElementById('responseText'); ta.value = ta.value + '\\n' + event.data };"
+ NEWLINE
+ " socket.onopen = function(event) { var ta = document.getElementById('responseText'); ta.value = \"Web Socket opened!\"; };"
+ NEWLINE
+ " socket.onclose = function(event) { var ta = document.getElementById('responseText'); ta.value = ta.value + \"Web Socket closed\"; };"
+ NEWLINE
+ "} else {"
+ NEWLINE
+ " alert(\"Your browser does not support Web Socket.\");"
+ NEWLINE
+ "}"
+ NEWLINE
+ NEWLINE
+ "function send(message) {"
+ NEWLINE
+ " if (!window.WebSocket) { return; }"
+ NEWLINE
+ " if (socket.readyState == WebSocket.OPEN) {"
+ NEWLINE
+ " socket.send(message);"
+ NEWLINE
+ " } else {"
+ NEWLINE
+ " alert(\"The socket is not open.\");"
+ NEWLINE
+ " }"
+ NEWLINE
+ "}"
+ NEWLINE
+ "</script>"
+ NEWLINE
+ "<form onsubmit=\"return false;\">"
+ NEWLINE
+ "<input type=\"text\" name=\"message\" value=\"Hello, World!\"/>"
+ "<input type=\"button\" value=\"Send Web Socket Data\" onclick=\"send(this.form.message.value)\" />"
+ NEWLINE + "<h3>Output</h3>" + NEWLINE
+ "<textarea id=\"responseText\" style=\"width: 500px; height:300px;\"></textarea>"
+ NEWLINE + "</form>" + NEWLINE + "</body>" + NEWLINE + "</html>" + NEWLINE,
CharsetUtil.US_ASCII);
}
private WebSocketSslServerIndexPage() {
// Unused
}
}

View File

@ -34,7 +34,7 @@ import org.jboss.netty.util.CharsetUtil;
* A UDP broadcast client that asks for a quote of the moment (QOTM) to * A UDP broadcast client that asks for a quote of the moment (QOTM) to
* {@link QuoteOfTheMomentServer}. * {@link QuoteOfTheMomentServer}.
* *
* Inspired by <a href="http://java.sun.com/docs/books/tutorial/networking/datagrams/clientServer.html">the official Java tutorial</a>. * Inspired by <a href="http://goo.gl/BsXVR">the official Java tutorial</a>.
*/ */
public class QuoteOfTheMomentClient { public class QuoteOfTheMomentClient {

View File

@ -32,7 +32,7 @@ import org.jboss.netty.util.CharsetUtil;
* A UDP server that responds to the QOTM (quote of the moment) request to a * A UDP server that responds to the QOTM (quote of the moment) request to a
* {@link QuoteOfTheMomentClient}. * {@link QuoteOfTheMomentClient}.
* *
* Inspired by <a href="http://java.sun.com/docs/books/tutorial/networking/datagrams/clientServer.html">the official Java tutorial</a>. * Inspired by <a href="http://goo.gl/BsXVR">the official Java tutorial</a>.
*/ */
public class QuoteOfTheMomentServer { public class QuoteOfTheMomentServer {

View File

@ -16,6 +16,7 @@
package org.jboss.netty.example.securechat; package org.jboss.netty.example.securechat;
import java.security.KeyStore; import java.security.KeyStore;
import java.security.SecureRandom;
import java.security.Security; import java.security.Security;
import javax.net.ssl.KeyManager; import javax.net.ssl.KeyManager;
@ -42,10 +43,10 @@ import org.jboss.netty.handler.ssl.SslHandler;
* {@link SslHandler}.</li> * {@link SslHandler}.</li>
* <li>When initializing an {@link SSLContext} on the client side, * <li>When initializing an {@link SSLContext} on the client side,
* specify the {@link KeyManager} that contains the client certificate as * specify the {@link KeyManager} that contains the client certificate as
* the first argument of {@link SSLContext#init(KeyManager[], javax.net.ssl.TrustManager[], java.security.SecureRandom)}.</li> * the first argument of {@link SSLContext#init(KeyManager[], TrustManager[], SecureRandom)}.</li>
* <li>When initializing an {@link SSLContext} on the server side, * <li>When initializing an {@link SSLContext} on the server side,
* specify the proper {@link TrustManager} as the second argument of * specify the proper {@link TrustManager} as the second argument of
* {@link SSLContext#init(KeyManager[], javax.net.ssl.TrustManager[], java.security.SecureRandom)} * {@link SSLContext#init(KeyManager[], TrustManager[], SecureRandom)}
* to validate the client certificate.</li> * to validate the client certificate.</li>
* </ul> * </ul>
*/ */

View File

@ -28,7 +28,9 @@ import org.jboss.netty.buffer.HeapChannelBufferFactory;
* <a href="http://en.wikipedia.org/wiki/Base64">Base64</a> notation. * <a href="http://en.wikipedia.org/wiki/Base64">Base64</a> notation.
* <p> * <p>
* The encoding and decoding algorithm in this class has been derived from * The encoding and decoding algorithm in this class has been derived from
* <a href="http://iharder.sourceforge.net/current/java/base64/">Robert Harder's Public Domain Base64 Encoder/Decoder</a>. * <a href="http://iharder.sourceforge.net/current/java/base64/">Robert Harder's Public Domain
* Base64 Encoder/Decoder</a>.
*
* @apiviz.landmark * @apiviz.landmark
* @apiviz.uses org.jboss.netty.handler.codec.base64.Base64Dialect * @apiviz.uses org.jboss.netty.handler.codec.base64.Base64Dialect
*/ */
@ -125,7 +127,8 @@ public final class Base64 {
return encode(src, off, len, Base64Dialect.STANDARD, bufferFactory); return encode(src, off, len, Base64Dialect.STANDARD, bufferFactory);
} }
public static ChannelBuffer encode(ChannelBuffer src, int off, int len, Base64Dialect dialect, ChannelBufferFactory bufferFactory) { public static ChannelBuffer encode(
ChannelBuffer src, int off, int len, Base64Dialect dialect, ChannelBufferFactory bufferFactory) {
return encode(src, off, len, breakLines(dialect), dialect, bufferFactory); return encode(src, off, len, breakLines(dialect), dialect, bufferFactory);
} }

View File

@ -23,7 +23,8 @@ package org.jboss.netty.handler.codec.base64;
* Enumeration of supported Base64 dialects. * Enumeration of supported Base64 dialects.
* <p> * <p>
* The internal lookup tables in this class has been derived from * The internal lookup tables in this class has been derived from
* <a href="http://iharder.sourceforge.net/current/java/base64/">Robert Harder's Public Domain Base64 Encoder/Decoder</a>. * <a href="http://iharder.sourceforge.net/current/java/base64/">Robert Harder's Public Domain
* Base64 Encoder/Decoder</a>.
*/ */
public enum Base64Dialect { public enum Base64Dialect {
/** /**

View File

@ -25,7 +25,8 @@ import org.jboss.netty.channel.DefaultChannelConfig;
/** /**
* TODO Make EmbeddedChannel implement ChannelConfig and ChannelSink to reduce overhead. * TODO Make EmbeddedChannel implement ChannelConfig and ChannelSink to reduce overhead.
* TODO Do not extend AbstractChannel to reduce overhead and remove the internal-use-only constructor in AbstractChannel. * TODO Do not extend AbstractChannel to reduce overhead and remove the internal-use-only
* constructor in AbstractChannel.
*/ */
class EmbeddedChannel extends AbstractChannel { class EmbeddedChannel extends AbstractChannel {

View File

@ -34,7 +34,7 @@ import org.jboss.netty.util.CharsetUtil;
* <pre> * <pre>
* String data = "foobar"; * String data = "foobar";
* *
* {@link EncoderEmbedder}&lt;{@link ChannelBuffer}&gt; embedder = new {@link EncoderEmbedder}&lt;{@link ChannelBuffer}&gt;( * {@link EncoderEmbedder}&lt;{@link ChannelBuffer}&gt; embedder = new {@link EncoderEmbedder}&lt;&gt;(
* new {@link Base64Encoder}(), new {@link StringEncoder}()); * new {@link Base64Encoder}(), new {@link StringEncoder}());
* *
* embedder.offer(data); * embedder.offer(data);

View File

@ -51,8 +51,11 @@ public class FixedLengthFrameDecoder extends FrameDecoder {
/** /**
* Creates a new instance. * Creates a new instance.
* *
* @param frameLength the length of the frame * @param frameLength
* @param allocateFullBuffer <code>true</code> if the cumulative {@link ChannelBuffer} should use the {@link #frameLength} as its initial size * the length of the frame
* @param allocateFullBuffer
* <code>true</code> if the cumulative {@link ChannelBuffer} should use the
* {@link #frameLength} as its initial size
*/ */
public FixedLengthFrameDecoder(int frameLength, boolean allocateFullBuffer) { public FixedLengthFrameDecoder(int frameLength, boolean allocateFullBuffer) {
if (frameLength <= 0) { if (frameLength <= 0) {

View File

@ -214,7 +214,8 @@ public abstract class FrameDecoder extends SimpleChannelUpstreamHandler implemen
callDecode(ctx, e.getChannel(), input, e.getRemoteAddress()); callDecode(ctx, e.getChannel(), input, e.getRemoteAddress());
} finally { } finally {
if (input.readable()) { if (input.readable()) {
// seems like there is something readable left in the input buffer. So create the cumulation buffer and copy the input into it // seems like there is something readable left in the input buffer. So create
// the cumulation buffer and copy the input into it
(cumulation = newCumulationBuffer(ctx, input.readableBytes())).writeBytes(input); (cumulation = newCumulationBuffer(ctx, input.readableBytes())).writeBytes(input);
} }
} }
@ -350,7 +351,8 @@ public abstract class FrameDecoder extends SimpleChannelUpstreamHandler implemen
} }
} }
protected final void unfoldAndFireMessageReceived(ChannelHandlerContext context, SocketAddress remoteAddress, Object result) { protected final void unfoldAndFireMessageReceived(
ChannelHandlerContext context, SocketAddress remoteAddress, Object result) {
if (unfold) { if (unfold) {
if (result instanceof Object[]) { if (result instanceof Object[]) {
for (Object r: (Object[]) result) { for (Object r: (Object[]) result) {
@ -369,8 +371,8 @@ public abstract class FrameDecoder extends SimpleChannelUpstreamHandler implemen
} }
/** /**
* Gets called on {@link #channelDisconnected(ChannelHandlerContext, ChannelStateEvent)} and {@link #channelClosed(ChannelHandlerContext, ChannelStateEvent)} * Gets called on {@link #channelDisconnected(ChannelHandlerContext, ChannelStateEvent)} and
* * {@link #channelClosed(ChannelHandlerContext, ChannelStateEvent)}
*/ */
protected void cleanup(ChannelHandlerContext ctx, ChannelStateEvent e) protected void cleanup(ChannelHandlerContext ctx, ChannelStateEvent e)
throws Exception { throws Exception {
@ -420,7 +422,8 @@ public abstract class FrameDecoder extends SimpleChannelUpstreamHandler implemen
*/ */
public void replace(String handlerName, ChannelHandler handler) { public void replace(String handlerName, ChannelHandler handler) {
if (ctx == null) { if (ctx == null) {
throw new IllegalStateException("Replace cann only be called once the FrameDecoder is added to the ChannelPipeline"); throw new IllegalStateException(
"Replace cann only be called once the FrameDecoder is added to the ChannelPipeline");
} }
ChannelPipeline pipeline = ctx.getPipeline(); ChannelPipeline pipeline = ctx.getPipeline();
pipeline.addAfter(ctx.getName(), handlerName, handler); pipeline.addAfter(ctx.getName(), handlerName, handler);

View File

@ -41,8 +41,8 @@ import java.util.regex.Pattern;
*/ */
public class CookieDecoder { public class CookieDecoder {
private static final Pattern PATTERN = private static final Pattern PATTERN = Pattern.compile(
Pattern.compile("(?:\\s|[;,])*\\$*([^;=]+)(?:=(?:[\"']((?:\\\\.|[^\"])*)[\"']|([^;,]*)))?(\\s*(?:[;,]+\\s*|$))"); "(?:\\s|[;,])*\\$*([^;=]+)(?:=(?:[\"']((?:\\\\.|[^\"])*)[\"']|([^;,]*)))?(\\s*(?:[;,]+\\s*|$))");
private static final String COMMA = ","; private static final String COMMA = ",";

View File

@ -219,7 +219,8 @@ public class HttpClientCodec implements ChannelUpstreamHandler,
if (failOnMissingResponse) { if (failOnMissingResponse) {
long missingResponses = requestResponseCounter.get(); long missingResponses = requestResponseCounter.get();
if (missingResponses > 0) { if (missingResponses > 0) {
throw new PrematureChannelClosureException("Channel closed but still missing " + missingResponses + " response(s)"); throw new PrematureChannelClosureException(
"Channel closed but still missing " + missingResponses + " response(s)");
} }
} }
} }

View File

@ -150,7 +150,8 @@ public abstract class HttpContentEncoder extends SimpleChannelHandler {
// the last product on closure, // the last product on closure,
if (lastProduct.readable()) { if (lastProduct.readable()) {
Channels.write( Channels.write(
ctx, Channels.succeededFuture(e.getChannel()), new DefaultHttpChunk(lastProduct), e.getRemoteAddress()); ctx, Channels.succeededFuture(e.getChannel()),
new DefaultHttpChunk(lastProduct), e.getRemoteAddress());
} }
// Emit the last chunk. // Emit the last chunk.

View File

@ -167,7 +167,8 @@ public abstract class HttpMessageDecoder extends ReplayingDecoder<HttpMessageDec
} }
@Override @Override
protected Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, State state) throws Exception { protected Object decode(
ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, State state) throws Exception {
switch (state) { switch (state) {
case SKIP_CONTROL_CHARS: { case SKIP_CONTROL_CHARS: {
try { try {
@ -270,7 +271,7 @@ public abstract class HttpMessageDecoder extends ReplayingDecoder<HttpMessageDec
return readFixedLengthContent(buffer); return readFixedLengthContent(buffer);
} }
case READ_FIXED_LENGTH_CONTENT_AS_CHUNKS: { case READ_FIXED_LENGTH_CONTENT_AS_CHUNKS: {
assert this.chunkSize <= Integer.MAX_VALUE; assert chunkSize <= Integer.MAX_VALUE;
int chunkSize = (int) this.chunkSize; int chunkSize = (int) this.chunkSize;
int readLimit = actualReadableBytes(); int readLimit = actualReadableBytes();
int toRead = chunkSize; int toRead = chunkSize;
@ -323,7 +324,7 @@ public abstract class HttpMessageDecoder extends ReplayingDecoder<HttpMessageDec
return chunk; return chunk;
} }
case READ_CHUNKED_CONTENT_AS_CHUNKS: { case READ_CHUNKED_CONTENT_AS_CHUNKS: {
assert this.chunkSize <= Integer.MAX_VALUE; assert chunkSize <= Integer.MAX_VALUE;
int chunkSize = (int) this.chunkSize; int chunkSize = (int) this.chunkSize;
int readLimit = actualReadableBytes(); int readLimit = actualReadableBytes();
int toRead = chunkSize; int toRead = chunkSize;

View File

@ -26,28 +26,32 @@ import java.util.Map;
*/ */
public class HttpMethod implements Comparable<HttpMethod> { public class HttpMethod implements Comparable<HttpMethod> {
/** /**
* The OPTIONS method represents a request for information about the communication options available on the request/response * The OPTIONS method represents a request for information about the communication options
* chain identified by the Request-URI. This method allows the client to determine the options and/or requirements * available on the request/response chain identified by the Request-URI. This method allows
* associated with a resource, or the capabilities of a server, without implying a resource action or initiating a * the client to determine the options and/or requirements associated with a resource, or the
* resource retrieval. * capabilities of a server, without implying a resource action or initiating a resource
* retrieval.
*/ */
public static final HttpMethod OPTIONS = new HttpMethod("OPTIONS"); public static final HttpMethod OPTIONS = new HttpMethod("OPTIONS");
/** /**
* The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. * The GET method means retrieve whatever information (in the form of an entity) is identified
* If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity * by the Request-URI. If the Request-URI refers to a data-producing process, it is the
* in the response and not the source text of the process, unless that text happens to be the output of the process. * produced data which shall be returned as the entity in the response and not the source text
* of the process, unless that text happens to be the output of the process.
*/ */
public static final HttpMethod GET = new HttpMethod("GET"); public static final HttpMethod GET = new HttpMethod("GET");
/** /**
* The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. * The HEAD method is identical to GET except that the server MUST NOT return a message-body in
* the response.
*/ */
public static final HttpMethod HEAD = new HttpMethod("HEAD"); public static final HttpMethod HEAD = new HttpMethod("HEAD");
/** /**
* The POST method is used to request that the origin server accept the entity enclosed in the request as a new * The POST method is used to request that the origin server accept the entity enclosed in the
* subordinate of the resource identified by the Request-URI in the Request-Line. * request as a new subordinate of the resource identified by the Request-URI in the
* Request-Line.
*/ */
public static final HttpMethod POST = new HttpMethod("POST"); public static final HttpMethod POST = new HttpMethod("POST");
@ -63,17 +67,20 @@ public class HttpMethod implements Comparable<HttpMethod> {
public static final HttpMethod PATCH = new HttpMethod("PATCH"); public static final HttpMethod PATCH = new HttpMethod("PATCH");
/** /**
* The DELETE method requests that the origin server delete the resource identified by the Request-URI. * The DELETE method requests that the origin server delete the resource identified by the
* Request-URI.
*/ */
public static final HttpMethod DELETE = new HttpMethod("DELETE"); public static final HttpMethod DELETE = new HttpMethod("DELETE");
/** /**
* The TRACE method is used to invoke a remote, application-layer loop- back of the request message. * The TRACE method is used to invoke a remote, application-layer loop- back of the request
* message.
*/ */
public static final HttpMethod TRACE = new HttpMethod("TRACE"); public static final HttpMethod TRACE = new HttpMethod("TRACE");
/** /**
* This specification reserves the method name CONNECT for use with a proxy that can dynamically switch to being a tunnel * This specification reserves the method name CONNECT for use with a proxy that can
* dynamically switch to being a tunnel
*/ */
public static final HttpMethod CONNECT = new HttpMethod("CONNECT"); public static final HttpMethod CONNECT = new HttpMethod("CONNECT");

View File

@ -102,7 +102,9 @@ public class HttpResponseDecoder extends HttpMessageDecoder {
@Override @Override
protected HttpMessage createMessage(String[] initialLine) { protected HttpMessage createMessage(String[] initialLine) {
return new DefaultHttpResponse(HttpVersion.valueOf(initialLine[0]), new HttpResponseStatus(Integer.valueOf(initialLine[1]), initialLine[2])); return new DefaultHttpResponse(
HttpVersion.valueOf(initialLine[0]),
new HttpResponseStatus(Integer.valueOf(initialLine[1]), initialLine[2]));
} }
@Override @Override

View File

@ -56,7 +56,8 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 203 Non-Authoritative Information (since HTTP/1.1) * 203 Non-Authoritative Information (since HTTP/1.1)
*/ */
public static final HttpResponseStatus NON_AUTHORITATIVE_INFORMATION = new HttpResponseStatus(203, "Non-Authoritative Information"); public static final HttpResponseStatus NON_AUTHORITATIVE_INFORMATION =
new HttpResponseStatus(203, "Non-Authoritative Information");
/** /**
* 204 No Content * 204 No Content
@ -151,7 +152,8 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 407 Proxy Authentication Required * 407 Proxy Authentication Required
*/ */
public static final HttpResponseStatus PROXY_AUTHENTICATION_REQUIRED = new HttpResponseStatus(407, "Proxy Authentication Required"); public static final HttpResponseStatus PROXY_AUTHENTICATION_REQUIRED =
new HttpResponseStatus(407, "Proxy Authentication Required");
/** /**
* 408 Request Timeout * 408 Request Timeout
@ -181,7 +183,8 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 413 Request Entity Too Large * 413 Request Entity Too Large
*/ */
public static final HttpResponseStatus REQUEST_ENTITY_TOO_LARGE = new HttpResponseStatus(413, "Request Entity Too Large"); public static final HttpResponseStatus REQUEST_ENTITY_TOO_LARGE =
new HttpResponseStatus(413, "Request Entity Too Large");
/** /**
* 414 Request-URI Too Long * 414 Request-URI Too Long
@ -191,12 +194,14 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 415 Unsupported Media Type * 415 Unsupported Media Type
*/ */
public static final HttpResponseStatus UNSUPPORTED_MEDIA_TYPE = new HttpResponseStatus(415, "Unsupported Media Type"); public static final HttpResponseStatus UNSUPPORTED_MEDIA_TYPE =
new HttpResponseStatus(415, "Unsupported Media Type");
/** /**
* 416 Requested Range Not Satisfiable * 416 Requested Range Not Satisfiable
*/ */
public static final HttpResponseStatus REQUESTED_RANGE_NOT_SATISFIABLE = new HttpResponseStatus(416, "Requested Range Not Satisfiable"); public static final HttpResponseStatus REQUESTED_RANGE_NOT_SATISFIABLE =
new HttpResponseStatus(416, "Requested Range Not Satisfiable");
/** /**
* 417 Expectation Failed * 417 Expectation Failed
@ -231,7 +236,8 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 500 Internal Server Error * 500 Internal Server Error
*/ */
public static final HttpResponseStatus INTERNAL_SERVER_ERROR = new HttpResponseStatus(500, "Internal Server Error"); public static final HttpResponseStatus INTERNAL_SERVER_ERROR =
new HttpResponseStatus(500, "Internal Server Error");
/** /**
* 501 Not Implemented * 501 Not Implemented
@ -256,12 +262,14 @@ public class HttpResponseStatus implements Comparable<HttpResponseStatus> {
/** /**
* 505 HTTP Version Not Supported * 505 HTTP Version Not Supported
*/ */
public static final HttpResponseStatus HTTP_VERSION_NOT_SUPPORTED = new HttpResponseStatus(505, "HTTP Version Not Supported"); public static final HttpResponseStatus HTTP_VERSION_NOT_SUPPORTED =
new HttpResponseStatus(505, "HTTP Version Not Supported");
/** /**
* 506 Variant Also Negotiates (RFC2295) * 506 Variant Also Negotiates (RFC2295)
*/ */
public static final HttpResponseStatus VARIANT_ALSO_NEGOTIATES = new HttpResponseStatus(506, "Variant Also Negotiates"); public static final HttpResponseStatus VARIANT_ALSO_NEGOTIATES =
new HttpResponseStatus(506, "Variant Also Negotiates");
/** /**
* 507 Insufficient Storage (WebDAV, RFC4918) * 507 Insufficient Storage (WebDAV, RFC4918)

View File

@ -47,10 +47,10 @@ import org.jboss.netty.util.CharsetUtil;
* *
* <h3>HashDOS vulnerability fix</h3> * <h3>HashDOS vulnerability fix</h3>
* *
* As a workaround to the <a href="http://events.ccc.de/congress/2011/Fahrplan/attachments/2007_28C3_Effective_DoS_on_web_application_platforms.pdf">HashDOS</a> * As a workaround to the <a href="http://goo.gl/I4Nky">HashDOS</a> vulnerability, the decoder
* vulnerability, the decoder limits the maximum number of decoded key-value * limits the maximum number of decoded key-value parameter pairs, up to {@literal 1024} by
* parameter pairs, up to {@literal 1024} by default, and you can configure it * default, and you can configure it when you construct the decoder by passing an additional
* when you construct the decoder by passing an additional integer parameter. * integer parameter.
* *
* @see QueryStringEncoder * @see QueryStringEncoder
* *

View File

@ -461,7 +461,8 @@ public class HttpPostRequestDecoder {
} else if (read == '&') { // special empty FIELD } else if (read == '&') { // special empty FIELD
currentStatus = MultiPartStatus.DISPOSITION; currentStatus = MultiPartStatus.DISPOSITION;
ampersandpos = currentpos - 1; ampersandpos = currentpos - 1;
String key = decodeAttribute(undecodedChunk.toString(firstpos, ampersandpos - firstpos, charset), charset); String key = decodeAttribute(
undecodedChunk.toString(firstpos, ampersandpos - firstpos, charset), charset);
currentAttribute = factory.createAttribute(request, key); currentAttribute = factory.createAttribute(request, key);
currentAttribute.setValue(""); // empty currentAttribute.setValue(""); // empty
addHttpData(currentAttribute); addHttpData(currentAttribute);
@ -587,7 +588,8 @@ public class HttpPostRequestDecoder {
} else if (read == '&') { // special empty FIELD } else if (read == '&') { // special empty FIELD
currentStatus = MultiPartStatus.DISPOSITION; currentStatus = MultiPartStatus.DISPOSITION;
ampersandpos = currentpos - 1; ampersandpos = currentpos - 1;
String key = decodeAttribute(undecodedChunk.toString(firstpos, ampersandpos - firstpos, charset), charset); String key = decodeAttribute(
undecodedChunk.toString(firstpos, ampersandpos - firstpos, charset), charset);
currentAttribute = factory.createAttribute(request, key); currentAttribute = factory.createAttribute(request, key);
currentAttribute.setValue(""); // empty currentAttribute.setValue(""); // empty
addHttpData(currentAttribute); addHttpData(currentAttribute);

View File

@ -20,8 +20,8 @@ import org.jboss.netty.buffer.ChannelBuffers;
import org.jboss.netty.util.CharsetUtil; import org.jboss.netty.util.CharsetUtil;
/** /**
* Web Socket continuation frame containing continuation text or binary data. This is used for fragmented messages where * Web Socket continuation frame containing continuation text or binary data. This is used for
* the contents of a messages is contained more than 1 frame. * fragmented messages where the contents of a messages is contained more than 1 frame.
*/ */
public class ContinuationWebSocketFrame extends WebSocketFrame { public class ContinuationWebSocketFrame extends WebSocketFrame {
@ -35,7 +35,8 @@ public class ContinuationWebSocketFrame extends WebSocketFrame {
} }
/** /**
* Creates a new continuation frame with the specified binary data. The final fragment flag is set to true. * Creates a new continuation frame with the specified binary data. The final fragment flag is
* set to true.
* *
* @param binaryData * @param binaryData
* the content of the frame. * the content of the frame.
@ -72,7 +73,8 @@ public class ContinuationWebSocketFrame extends WebSocketFrame {
* @param aggregatedText * @param aggregatedText
* Aggregated text set by decoder on the final continuation frame of a fragmented text message * Aggregated text set by decoder on the final continuation frame of a fragmented text message
*/ */
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, ChannelBuffer binaryData, String aggregatedText) { public ContinuationWebSocketFrame(
boolean finalFragment, int rsv, ChannelBuffer binaryData, String aggregatedText) {
setFinalFragment(finalFragment); setFinalFragment(finalFragment);
setRsv(rsv); setRsv(rsv);
setBinaryData(binaryData); setBinaryData(binaryData);

View File

@ -18,19 +18,20 @@
* *
* Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de> * Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation * and associated documentation files (the "Software"), to deal in the Software without restriction,
* the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and * including without limitation the rights to use, copy, modify, merge, publish, distribute,
* to permit persons to whom the Software is furnished to do so, subject to the following conditions: * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* *
* The above copyright notice and this permission notice shall be included in all copies or substantial portions * The above copyright notice and this permission notice shall be included in all copies or
* of the Software. * substantial portions of the Software.
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
* THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* IN THE SOFTWARE. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
package org.jboss.netty.handler.codec.http.websocketx; package org.jboss.netty.handler.codec.http.websocketx;

View File

@ -18,19 +18,20 @@
* *
* Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de> * Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation * and associated documentation files (the "Software"), to deal in the Software without restriction,
* the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and * including without limitation the rights to use, copy, modify, merge, publish, distribute,
* to permit persons to whom the Software is furnished to do so, subject to the following conditions: * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* *
* The above copyright notice and this permission notice shall be included in all copies or substantial portions * The above copyright notice and this permission notice shall be included in all copies or
* of the Software. * substantial portions of the Software.
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
* THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* IN THE SOFTWARE. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
package org.jboss.netty.handler.codec.http.websocketx; package org.jboss.netty.handler.codec.http.websocketx;
@ -41,20 +42,23 @@ final class UTF8Output {
private static final int UTF8_ACCEPT = 0; private static final int UTF8_ACCEPT = 0;
private static final int UTF8_REJECT = 12; private static final int UTF8_REJECT = 12;
private static final byte[] TYPES = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, private static final byte[] TYPES = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1,
7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 8, 8, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 7, 7, 7, 7,
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 10, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, 11, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 8,
6, 6, 6, 5, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8 }; 8, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
2, 2, 10, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, 11, 6, 6, 6, 5, 8, 8, 8, 8, 8,
8, 8, 8, 8, 8, 8 };
private static final byte[] STATES = { 0, 12, 24, 36, 60, 96, 84, 12, 12, 12, 48, 72, 12, 12, 12, 12, 12, 12, 12, private static final byte[] STATES = { 0, 12, 24, 36, 60, 96, 84, 12, 12, 12, 48, 72, 12, 12,
12, 12, 12, 12, 12, 12, 0, 12, 12, 12, 12, 12, 0, 12, 0, 12, 12, 12, 24, 12, 12, 12, 12, 12, 24, 12, 24, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 0, 12, 12, 12, 12, 12, 0, 12, 0, 12, 12,
12, 12, 12, 12, 12, 12, 12, 12, 12, 24, 12, 12, 12, 12, 12, 24, 12, 12, 12, 12, 12, 12, 12, 24, 12, 12, 12, 12, 24, 12, 12, 12, 12, 12, 24, 12, 24, 12, 12, 12, 12, 12, 12, 12, 12, 12, 24, 12, 12,
12, 12, 12, 12, 12, 12, 36, 12, 36, 12, 12, 12, 36, 12, 12, 12, 12, 12, 36, 12, 36, 12, 12, 12, 36, 12, 12, 12, 12, 12, 24, 12, 12, 12, 12, 12, 12, 12, 24, 12, 12, 12, 12, 12, 12, 12, 12, 12, 36,
12, 12, 12, 12, 12, 12, 12, 12 }; 12, 36, 12, 12, 12, 36, 12, 12, 12, 12, 12, 36, 12, 36, 12, 12, 12, 36, 12, 12, 12, 12,
12, 12, 12, 12, 12, 12 };
private int state = UTF8_ACCEPT; private int state = UTF8_ACCEPT;
private int codep; private int codep;

View File

@ -27,8 +27,8 @@ public class WebSocketClientHandshakerFactory {
* Instances a new handshaker * Instances a new handshaker
* *
* @param webSocketURL * @param webSocketURL
* URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be * URL for web socket communications. e.g "ws://myhost.com/mypath".
* sent to this URL. * Subsequent web socket frames will be sent to this URL.
* @param version * @param version
* Version of web socket specification to use to connect to the server * Version of web socket specification to use to connect to the server
* @param subprotocol * @param subprotocol
@ -48,8 +48,8 @@ public class WebSocketClientHandshakerFactory {
* Instances a new handshaker * Instances a new handshaker
* *
* @param webSocketURL * @param webSocketURL
* URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be * URL for web socket communications. e.g "ws://myhost.com/mypath".
* sent to this URL. * Subsequent web socket frames will be sent to this URL.
* @param version * @param version
* Version of web socket specification to use to connect to the server * Version of web socket specification to use to connect to the server
* @param subprotocol * @param subprotocol
@ -59,20 +59,24 @@ public class WebSocketClientHandshakerFactory {
* @param customHeaders * @param customHeaders
* Custom HTTP headers to send during the handshake * Custom HTTP headers to send during the handshake
* @param maxFramePayloadLength * @param maxFramePayloadLength
* Maximum allowable frame payload length. Setting this value to your application's requirement may * Maximum allowable frame payload length. Setting this value to your application's
* reduce denial of service attacks using long data frames. * requirement may reduce denial of service attacks using long data frames.
* @throws WebSocketHandshakeException
*/ */
public WebSocketClientHandshaker newHandshaker(URI webSocketURL, WebSocketVersion version, String subprotocol, public WebSocketClientHandshaker newHandshaker(
boolean allowExtensions, Map<String, String> customHeaders, long maxFramePayloadLength) throws WebSocketHandshakeException { URI webSocketURL, WebSocketVersion version, String subprotocol,
boolean allowExtensions, Map<String, String> customHeaders, long maxFramePayloadLength)
throws WebSocketHandshakeException {
if (version == WebSocketVersion.V13) { if (version == WebSocketVersion.V13) {
return new WebSocketClientHandshaker13(webSocketURL, version, subprotocol, allowExtensions, customHeaders, maxFramePayloadLength); return new WebSocketClientHandshaker13(
webSocketURL, version, subprotocol, allowExtensions, customHeaders, maxFramePayloadLength);
} }
if (version == WebSocketVersion.V08) { if (version == WebSocketVersion.V08) {
return new WebSocketClientHandshaker08(webSocketURL, version, subprotocol, allowExtensions, customHeaders, maxFramePayloadLength); return new WebSocketClientHandshaker08(
webSocketURL, version, subprotocol, allowExtensions, customHeaders, maxFramePayloadLength);
} }
if (version == WebSocketVersion.V00) { if (version == WebSocketVersion.V00) {
return new WebSocketClientHandshaker00(webSocketURL, version, subprotocol, customHeaders, maxFramePayloadLength); return new WebSocketClientHandshaker00(
webSocketURL, version, subprotocol, customHeaders, maxFramePayloadLength);
} }
throw new WebSocketHandshakeException("Protocol version " + version.toString() + " not supported."); throw new WebSocketHandshakeException("Protocol version " + version.toString() + " not supported.");

View File

@ -67,8 +67,8 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
* Constructor specifying the destination web socket location * Constructor specifying the destination web socket location
* *
* @param webSocketURL * @param webSocketURL
* URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be * URL for web socket communications. e.g "ws://myhost.com/mypath".
* sent to this URL. * Subsequent web socket frames will be sent to this URL.
* @param subprotocols * @param subprotocols
* CSV of supported protocols * CSV of supported protocols
* @param maxFramePayloadLength * @param maxFramePayloadLength

View File

@ -52,15 +52,15 @@ public class WebSocketServerHandshakerFactory {
* Constructor * Constructor
* *
* @param webSocketURL * @param webSocketURL
* URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be * URL for web socket communications. e.g "ws://myhost.com/mypath".
* sent to this URL. * Subsequent web socket frames will be sent to this URL.
* @param subprotocols * @param subprotocols
* CSV of supported protocols. Null if sub protocols not supported. * CSV of supported protocols. Null if sub protocols not supported.
* @param allowExtensions * @param allowExtensions
* Allow extensions to be used in the reserved bits of the web socket frame * Allow extensions to be used in the reserved bits of the web socket frame
* @param maxFramePayloadLength * @param maxFramePayloadLength
* Maximum allowable frame payload length. Setting this value to your application's requirement may * Maximum allowable frame payload length. Setting this value to your application's
* reduce denial of service attacks using long data frames. * requirement may reduce denial of service attacks using long data frames.
*/ */
public WebSocketServerHandshakerFactory(String webSocketURL, String subprotocols, boolean allowExtensions, public WebSocketServerHandshakerFactory(String webSocketURL, String subprotocols, boolean allowExtensions,
long maxFramePayloadLength) { long maxFramePayloadLength) {
@ -73,8 +73,8 @@ public class WebSocketServerHandshakerFactory {
/** /**
* Instances a new handshaker * Instances a new handshaker
* *
* @return A new WebSocketServerHandshaker for the requested web socket version. Null if web socket version is not * @return A new WebSocketServerHandshaker for the requested web socket version. Null if web
* supported. * socket version is not supported.
*/ */
public WebSocketServerHandshaker newHandshaker(HttpRequest req) { public WebSocketServerHandshaker newHandshaker(HttpRequest req) {
@ -82,16 +82,19 @@ public class WebSocketServerHandshakerFactory {
if (version != null) { if (version != null) {
if (version.equals(WebSocketVersion.V13.toHttpHeaderValue())) { if (version.equals(WebSocketVersion.V13.toHttpHeaderValue())) {
// Version 13 of the wire protocol - RFC 6455 (version 17 of the draft hybi specification). // Version 13 of the wire protocol - RFC 6455 (version 17 of the draft hybi specification).
return new WebSocketServerHandshaker13(webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength); return new WebSocketServerHandshaker13(
webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength);
} else if (version.equals(WebSocketVersion.V08.toHttpHeaderValue())) { } else if (version.equals(WebSocketVersion.V08.toHttpHeaderValue())) {
// Version 8 of the wire protocol - version 10 of the draft hybi specification. // Version 8 of the wire protocol - version 10 of the draft hybi specification.
return new WebSocketServerHandshaker08(webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength); return new WebSocketServerHandshaker08(
webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength);
} else { } else {
return null; return null;
} }
} else { } else {
// Assume version 00 where version header was not specified // Assume version 00 where version header was not specified
return new WebSocketServerHandshaker00(webSocketURL, subprotocols, maxFramePayloadLength); return new WebSocketServerHandshaker00(
webSocketURL, subprotocols, maxFramePayloadLength);
} }
} }

View File

@ -21,9 +21,10 @@
* This package supports different web socket specification versions (hence the X suffix). * This package supports different web socket specification versions (hence the X suffix).
* The specification current supported are: * The specification current supported are:
* <ul> * <ul>
* <li><a href="http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00">draft-ietf-hybi-thewebsocketprotocol-00</a></li> * <li><a href="http://goo.gl/wFiu3">draft-ietf-hybi-thewebsocketprotocol-00</a></li>
* <li><a href="http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10">draft-ietf-hybi-thewebsocketprotocol-10</a></li> * <li><a href="http://goo.gl/h27VE">draft-ietf-hybi-thewebsocketprotocol-10</a></li>
* <li><a href="http://tools.ietf.org/html/rfc6455 ">RFC 6455</a> (originally <a href="http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17">draft-ietf-hybi-thewebsocketprotocol-17</a>)</li> * <li><a href="http://tools.ietf.org/html/rfc6455 ">RFC 6455</a> (originally
* <a href="http://goo.gl/zVBkL">draft-ietf-hybi-thewebsocketprotocol-17</a>)</li>
* </ul> * </ul>
* </p> * </p>
* <p> * <p>

View File

@ -42,12 +42,15 @@ public class CompatibleMarshallingDecoder extends ReplayingDecoder<VoidEnum> {
/** /**
* Create a new instance of {@link CompatibleMarshallingDecoder}. * Create a new instance of {@link CompatibleMarshallingDecoder}.
* *
* @param provider the {@link UnmarshallerProvider} which is used to obtain the {@link Unmarshaller} for the {@link Channel} * @param provider
* @param maxObjectSize the maximal size (in bytes) of the {@link Object} to unmarshal. Once the size is exceeded * the {@link UnmarshallerProvider} which is used to obtain the {@link Unmarshaller}
* the {@link Channel} will get closed. Use a a maxObjectSize of {@link Integer#MAX_VALUE} to disable this. * for the {@link Channel}
* You should only do this if you are sure that the received Objects will never be big and the * @param maxObjectSize
* sending side are trusted, as this opens the possibility for a DOS-Attack due an {@link OutOfMemoryError}. * the maximal size (in bytes) of the {@link Object} to unmarshal. Once the size is
* * exceeded the {@link Channel} will get closed. Use a a maxObjectSize of
* {@link Integer#MAX_VALUE} to disable this. You should only do this if you are sure
* that the received Objects will never be big and the sending side are trusted, as
* this opens the possibility for a DOS-Attack due an {@link OutOfMemoryError}.
*/ */
public CompatibleMarshallingDecoder(UnmarshallerProvider provider, int maxObjectSize) { public CompatibleMarshallingDecoder(UnmarshallerProvider provider, int maxObjectSize) {
this.provider = provider; this.provider = provider;
@ -55,7 +58,8 @@ public class CompatibleMarshallingDecoder extends ReplayingDecoder<VoidEnum> {
} }
@Override @Override
protected Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, VoidEnum state) throws Exception { protected Object decode(
ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, VoidEnum state) throws Exception {
Unmarshaller unmarshaller = provider.getUnmarshaller(ctx); Unmarshaller unmarshaller = provider.getUnmarshaller(ctx);
ByteInput input = new ChannelBufferByteInput(buffer); ByteInput input = new ChannelBufferByteInput(buffer);
if (maxObjectSize != Integer.MAX_VALUE) { if (maxObjectSize != Integer.MAX_VALUE) {

View File

@ -50,7 +50,8 @@ public class CompatibleMarshallingEncoder extends OneToOneEncoder {
@Override @Override
protected Object encode(ChannelHandlerContext ctx, Channel channel, Object msg) throws Exception { protected Object encode(ChannelHandlerContext ctx, Channel channel, Object msg) throws Exception {
Marshaller marshaller = provider.getMarshaller(ctx); Marshaller marshaller = provider.getMarshaller(ctx);
ChannelBufferByteOutput output = new ChannelBufferByteOutput(ctx.getChannel().getConfig().getBufferFactory(), 256); ChannelBufferByteOutput output =
new ChannelBufferByteOutput(ctx.getChannel().getConfig().getBufferFactory(), 256);
marshaller.start(output); marshaller.start(output);
marshaller.writeObject(msg); marshaller.writeObject(msg);
marshaller.finish(); marshaller.finish();
@ -58,5 +59,4 @@ public class CompatibleMarshallingEncoder extends OneToOneEncoder {
return output.getBuffer(); return output.getBuffer();
} }
} }

View File

@ -27,7 +27,8 @@ import org.jboss.netty.handler.codec.frame.TooLongFrameException;
/** /**
* Decoder which MUST be used with {@link MarshallingEncoder}. * Decoder which MUST be used with {@link MarshallingEncoder}.
* *
* A {@link LengthFieldBasedFrameDecoder} which use an {@link Unmarshaller} to read the Object out of the {@link ChannelBuffer}. * A {@link LengthFieldBasedFrameDecoder} which use an {@link Unmarshaller} to read the Object out
* of the {@link ChannelBuffer}.
* *
*/ */
public class MarshallingDecoder extends LengthFieldBasedFrameDecoder { public class MarshallingDecoder extends LengthFieldBasedFrameDecoder {
@ -77,8 +78,8 @@ public class MarshallingDecoder extends LengthFieldBasedFrameDecoder {
unmarshaller.finish(); unmarshaller.finish();
return obj; return obj;
} finally { } finally {
// Call close in a finally block as the ReplayingDecoder will throw an Error if not enough bytes are // Call close in a finally block as the ReplayingDecoder will throw an Error if not
// readable. This helps to be sure that we do not leak resource // enough bytes are readable. This helps to be sure that we do not leak resource
unmarshaller.close(); unmarshaller.close();
} }
} }

View File

@ -75,7 +75,8 @@ public class MarshallingEncoder extends OneToOneEncoder {
@Override @Override
protected Object encode(ChannelHandlerContext ctx, Channel channel, Object msg) throws Exception { protected Object encode(ChannelHandlerContext ctx, Channel channel, Object msg) throws Exception {
Marshaller marshaller = provider.getMarshaller(ctx); Marshaller marshaller = provider.getMarshaller(ctx);
ChannelBufferByteOutput output = new ChannelBufferByteOutput(ctx.getChannel().getConfig().getBufferFactory(), estimatedLength); ChannelBufferByteOutput output = new ChannelBufferByteOutput(
ctx.getChannel().getConfig().getBufferFactory(), estimatedLength);
output.getBuffer().writeBytes(LENGTH_PLACEHOLDER); output.getBuffer().writeBytes(LENGTH_PLACEHOLDER);
marshaller.start(output); marshaller.start(output);
marshaller.writeObject(msg); marshaller.writeObject(msg);

View File

@ -389,8 +389,9 @@ public abstract class ReplayingDecoder<T extends Enum<T>>
} }
/** /**
* Calls {@link #decode(ChannelHandlerContext, Channel, ChannelBuffer, Enum)}. This method should be never used by {@link ReplayingDecoder} itself. * Calls {@link #decode(ChannelHandlerContext, Channel, ChannelBuffer, Enum)}. This method
* But to be safe we should handle it anyway * should be never used by {@link ReplayingDecoder} itself. But to be safe we should handle it
* anyway
*/ */
@Override @Override
protected final Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer) throws Exception { protected final Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer) throws Exception {
@ -520,7 +521,9 @@ public abstract class ReplayingDecoder<T extends Enum<T>>
} }
} }
private void callDecode(ChannelHandlerContext context, Channel channel, ChannelBuffer input, ChannelBuffer replayableInput, SocketAddress remoteAddress) throws Exception { private void callDecode(
ChannelHandlerContext context, Channel channel,
ChannelBuffer input, ChannelBuffer replayableInput, SocketAddress remoteAddress) throws Exception {
while (input.readable()) { while (input.readable()) {
int oldReaderIndex = checkpoint = input.readerIndex(); int oldReaderIndex = checkpoint = input.readerIndex();
Object result = null; Object result = null;

View File

@ -27,10 +27,11 @@ import org.jboss.netty.handler.codec.http.HttpMethod;
public final class RtspMethods { public final class RtspMethods {
/** /**
* The OPTIONS method represents a request for information about the communication options available on the request/response * The OPTIONS method represents a request for information about the communication options
* chain identified by the Request-URI. This method allows the client to determine the options and/or requirements * available on the request/response chain identified by the Request-URI. This method allows
* associated with a resource, or the capabilities of a server, without implying a resource action or initiating a * the client to determine the options and/or requirements associated with a resource, or the
* resource retrieval. * capabilities of a server, without implying a resource action or initiating a resource
* retrieval.
*/ */
public static final HttpMethod OPTIONS = HttpMethod.OPTIONS; public static final HttpMethod OPTIONS = HttpMethod.OPTIONS;

View File

@ -107,7 +107,8 @@ public final class RtspResponseStatuses {
/** /**
* 407 Proxy Authentication Required * 407 Proxy Authentication Required
*/ */
public static final HttpResponseStatus PROXY_AUTHENTICATION_REQUIRED = HttpResponseStatus.PROXY_AUTHENTICATION_REQUIRED; public static final HttpResponseStatus PROXY_AUTHENTICATION_REQUIRED =
HttpResponseStatus.PROXY_AUTHENTICATION_REQUIRED;
/** /**
* 408 Request Timeout * 408 Request Timeout

View File

@ -38,7 +38,9 @@ public final class ClassResolvers {
* @return new instance of class resolver * @return new instance of class resolver
*/ */
public static ClassResolver weakCachingResolver(ClassLoader classLoader) { public static ClassResolver weakCachingResolver(ClassLoader classLoader) {
return new CachingClassResolver(new ClassLoaderClassResolver(defaultClassLoader(classLoader)), new WeakReferenceMap<String, Class<?>>(new HashMap<String, Reference<Class<?>>>())); return new CachingClassResolver(
new ClassLoaderClassResolver(defaultClassLoader(classLoader)),
new WeakReferenceMap<String, Class<?>>(new HashMap<String, Reference<Class<?>>>()));
} }
/** /**
@ -49,7 +51,9 @@ public final class ClassResolvers {
* @return new instance of class resolver * @return new instance of class resolver
*/ */
public static ClassResolver softCachingResolver(ClassLoader classLoader) { public static ClassResolver softCachingResolver(ClassLoader classLoader) {
return new CachingClassResolver(new ClassLoaderClassResolver(defaultClassLoader(classLoader)), new SoftReferenceMap<String, Class<?>>(new HashMap<String, Reference<Class<?>>>())); return new CachingClassResolver(
new ClassLoaderClassResolver(defaultClassLoader(classLoader)),
new SoftReferenceMap<String, Class<?>>(new HashMap<String, Reference<Class<?>>>()));
} }
/** /**
@ -60,7 +64,9 @@ public final class ClassResolvers {
* @return new instance of class resolver * @return new instance of class resolver
*/ */
public static ClassResolver weakCachingConcurrentResolver(ClassLoader classLoader) { public static ClassResolver weakCachingConcurrentResolver(ClassLoader classLoader) {
return new CachingClassResolver(new ClassLoaderClassResolver(defaultClassLoader(classLoader)), new WeakReferenceMap<String, Class<?>>(new ConcurrentHashMap<String, Reference<Class<?>>>())); return new CachingClassResolver(
new ClassLoaderClassResolver(defaultClassLoader(classLoader)),
new WeakReferenceMap<String, Class<?>>(new ConcurrentHashMap<String, Reference<Class<?>>>()));
} }
/** /**
@ -71,7 +77,9 @@ public final class ClassResolvers {
* @return new instance of class resolver * @return new instance of class resolver
*/ */
public static ClassResolver softCachingConcurrentResolver(ClassLoader classLoader) { public static ClassResolver softCachingConcurrentResolver(ClassLoader classLoader) {
return new CachingClassResolver(new ClassLoaderClassResolver(defaultClassLoader(classLoader)), new SoftReferenceMap<String, Class<?>>(new ConcurrentHashMap<String, Reference<Class<?>>>())); return new CachingClassResolver(
new ClassLoaderClassResolver(defaultClassLoader(classLoader)),
new SoftReferenceMap<String, Class<?>>(new ConcurrentHashMap<String, Reference<Class<?>>>()));
} }
static ClassLoader defaultClassLoader(ClassLoader classLoader) { static ClassLoader defaultClassLoader(ClassLoader classLoader) {

View File

@ -74,7 +74,8 @@ public class CompatibleObjectDecoder extends ReplayingDecoder<CompatibleObjectDe
@Override @Override
protected Object decode( protected Object decode(
ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, CompatibleObjectDecoderState state) throws Exception { ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer,
CompatibleObjectDecoderState state) throws Exception {
bin.switchStream(new ChannelBufferInputStream(buffer)); bin.switchStream(new ChannelBufferInputStream(buffer));
switch (state) { switch (state) {
case READ_HEADER: case READ_HEADER:

View File

@ -97,7 +97,8 @@ public class ObjectDecoder extends LengthFieldBasedFrameDecoder {
/** /**
* Create a new decoder with the specified maximum object size and the {@link ClassLoader} wrapped in {@link ClassResolvers#weakCachingResolver(ClassLoader)} * Create a new decoder with the specified maximum object size and the {@link ClassLoader}
* wrapped in {@link ClassResolvers#weakCachingResolver(ClassLoader)}.
* *
* @param maxObjectSize the maximum byte length of the serialized object. * @param maxObjectSize the maximum byte length of the serialized object.
* if the length of the received object is greater * if the length of the received object is greater

View File

@ -280,7 +280,8 @@ public class SpdyHttpEncoder implements ChannelDownstreamHandler {
httpMessage.removeHeader("Proxy-Connection"); httpMessage.removeHeader("Proxy-Connection");
httpMessage.removeHeader(HttpHeaders.Names.TRANSFER_ENCODING); httpMessage.removeHeader(HttpHeaders.Names.TRANSFER_ENCODING);
SpdySynStreamFrame spdySynStreamFrame = new DefaultSpdySynStreamFrame(streamID, associatedToStreamID, priority); SpdySynStreamFrame spdySynStreamFrame =
new DefaultSpdySynStreamFrame(streamID, associatedToStreamID, priority);
// Unfold the first line of the message into name/value pairs // Unfold the first line of the message into name/value pairs
if (httpMessage instanceof HttpRequest) { if (httpMessage instanceof HttpRequest) {

View File

@ -479,7 +479,8 @@ public class SpdySessionHandler extends SimpleChannelUpstreamHandler
e.getFuture().addListener(new ChannelFutureListener() { e.getFuture().addListener(new ChannelFutureListener() {
public void operationComplete(ChannelFuture future) throws Exception { public void operationComplete(ChannelFuture future) throws Exception {
if (!future.isSuccess()) { if (!future.isSuccess()) {
issueStreamError(context, remoteAddress, streamID, SpdyStreamStatus.INTERNAL_ERROR); issueStreamError(
context, remoteAddress, streamID, SpdyStreamStatus.INTERNAL_ERROR);
} }
} }
}); });
@ -504,7 +505,8 @@ public class SpdySessionHandler extends SimpleChannelUpstreamHandler
e.getFuture().addListener(new ChannelFutureListener() { e.getFuture().addListener(new ChannelFutureListener() {
public void operationComplete(ChannelFuture future) throws Exception { public void operationComplete(ChannelFuture future) throws Exception {
if (!future.isSuccess()) { if (!future.isSuccess()) {
issueStreamError(context, remoteAddress, streamID, SpdyStreamStatus.INTERNAL_ERROR); issueStreamError(
context, remoteAddress, streamID, SpdyStreamStatus.INTERNAL_ERROR);
} }
} }
}); });
@ -737,7 +739,8 @@ public class SpdySessionHandler extends SimpleChannelUpstreamHandler
return false; return false;
} }
spdySession.acceptStream( spdySession.acceptStream(
streamID, priority, remoteSideClosed, localSideClosed, initialSendWindowSize, initialReceiveWindowSize); streamID, priority, remoteSideClosed, localSideClosed,
initialSendWindowSize, initialReceiveWindowSize);
if (isRemoteInitiatedID(streamID)) { if (isRemoteInitiatedID(streamID)) {
lastGoodStreamID = streamID; lastGoodStreamID = streamID;
} }

View File

@ -32,10 +32,12 @@ public class ChainedExecutor implements Executor, ExternalResourceReleasable {
private final ChannelEventRunnableFilter filter; private final ChannelEventRunnableFilter filter;
/** /**
* Create a new {@link ChainedExecutor} which will used the given {@link ChannelEventRunnableFilter} to see if the {@link #cur} {@link Executor} should get used. * Create a new {@link ChainedExecutor} which will used the given
* Otherwise it will pass the work to the {@link #next} {@link Executor} * {@link ChannelEventRunnableFilter} to see if the {@link #cur} {@link Executor} should get
* used. Otherwise it will pass the work to the {@link #next} {@link Executor}
* *
* @param filter the {@link ChannelEventRunnableFilter} which will be used to check if the {@link ChannelEventRunnable} should be passed to the cur or next {@link Executor} * @param filter the {@link ChannelEventRunnableFilter} which will be used to check if the
* {@link ChannelEventRunnable} should be passed to the cur or next {@link Executor}
* @param cur the {@link Executor} to use if the {@link ChannelEventRunnableFilter} match * @param cur the {@link Executor} to use if the {@link ChannelEventRunnableFilter} match
* @param next the {@link Executor} to use if the {@link ChannelEventRunnableFilter} does not match * @param next the {@link Executor} to use if the {@link ChannelEventRunnableFilter} does not match
*/ */
@ -56,8 +58,9 @@ public class ChainedExecutor implements Executor, ExternalResourceReleasable {
} }
/** /**
* Execute the passed {@link ChannelEventRunnable} with the current {@link Executor} if the {@link ChannelEventRunnableFilter} match. * Execute the passed {@link ChannelEventRunnable} with the current {@link Executor} if the
* Otherwise pass it to the next {@link Executor} in the chain. * {@link ChannelEventRunnableFilter} match. Otherwise pass it to the next {@link Executor} in
* the chain.
*/ */
public void execute(Runnable command) { public void execute(Runnable command) {
assert command instanceof ChannelEventRunnable; assert command instanceof ChannelEventRunnable;

View File

@ -182,7 +182,9 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
int corePoolSize, long maxChannelMemorySize, long maxTotalMemorySize, int corePoolSize, long maxChannelMemorySize, long maxTotalMemorySize,
long keepAliveTime, TimeUnit unit) { long keepAliveTime, TimeUnit unit) {
this(corePoolSize, maxChannelMemorySize, maxTotalMemorySize, keepAliveTime, unit, Executors.defaultThreadFactory()); this(
corePoolSize, maxChannelMemorySize, maxTotalMemorySize, keepAliveTime, unit,
Executors.defaultThreadFactory());
} }
/** /**
@ -201,7 +203,9 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
int corePoolSize, long maxChannelMemorySize, long maxTotalMemorySize, int corePoolSize, long maxChannelMemorySize, long maxTotalMemorySize,
long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory) { long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory) {
this(corePoolSize, maxChannelMemorySize, maxTotalMemorySize, keepAliveTime, unit, new DefaultObjectSizeEstimator(), threadFactory); this(
corePoolSize, maxChannelMemorySize, maxTotalMemorySize, keepAliveTime, unit,
new DefaultObjectSizeEstimator(), threadFactory);
} }
/** /**
@ -277,11 +281,13 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
} }
/** /**
* See {@link ThreadPoolExecutor#shutdownNow()} for how it handles the shutdown. If <code>true</code> is given to this method it also notifies all {@link ChannelFuture}'s * See {@link ThreadPoolExecutor#shutdownNow()} for how it handles the shutdown.
* If <code>true</code> is given to this method it also notifies all {@link ChannelFuture}'s
* of the not executed {@link ChannelEventRunnable}'s. * of the not executed {@link ChannelEventRunnable}'s.
* *
* <p> * <p>
* Be aware that if you call this with <code>false</code> you will need to handle the notification of the {@link ChannelFuture}'s by your self. So only use this if you * Be aware that if you call this with <code>false</code> you will need to handle the
* notification of the {@link ChannelFuture}'s by your self. So only use this if you
* really have a use-case for it. * really have a use-case for it.
* </p> * </p>
* *
@ -395,11 +401,13 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
} }
/** /**
* If set to <code>false</code> no queued {@link ChannelEventRunnable}'s {@link ChannelFuture} will get notified once {@link #shutdownNow()} is called. * If set to <code>false</code> no queued {@link ChannelEventRunnable}'s {@link ChannelFuture}
* If set to <code>true</code> every queued {@link ChannelEventRunnable} will get marked as failed via {@link ChannelFuture#setFailure(Throwable)}. * will get notified once {@link #shutdownNow()} is called. If set to <code>true</code> every
* queued {@link ChannelEventRunnable} will get marked as failed via {@link ChannelFuture#setFailure(Throwable)}.
* *
* <p> * <p>
* Please only set this to <code>false</code> if you want to handle the notification by yourself and know what you are doing. Default is <code>true</code>. * Please only set this to <code>false</code> if you want to handle the notification by yourself
* and know what you are doing. Default is <code>true</code>.
* </p> * </p>
*/ */
public void setNotifyChannelFuturesOnShutdown(boolean notifyOnShutdown) { public void setNotifyChannelFuturesOnShutdown(boolean notifyOnShutdown) {
@ -524,8 +532,9 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
//System.out.println("READABLE"); //System.out.println("READABLE");
ChannelHandlerContext ctx = eventTask.getContext(); ChannelHandlerContext ctx = eventTask.getContext();
if (ctx.getHandler() instanceof ExecutionHandler) { if (ctx.getHandler() instanceof ExecutionHandler) {
// check if the attachment was set as this means that we suspend the channel from reads. This only works when // check if the attachment was set as this means that we suspend the channel
// this pool is used with ExecutionHandler but I guess thats good enough for us. // from reads. This only works when this pool is used with ExecutionHandler
// but I guess thats good enough for us.
// //
// See #215 // See #215
if (ctx.getAttachment() != null) { if (ctx.getAttachment() != null) {

View File

@ -28,13 +28,13 @@ import org.jboss.netty.channel.ChannelFutureListener;
import org.jboss.netty.util.ObjectSizeEstimator; import org.jboss.netty.util.ObjectSizeEstimator;
/** /**
* {@link Executor} which should be used for downstream {@link ChannelEvent}'s. This implementation will take care of preserve the order of the events in a {@link Channel}. * {@link Executor} which should be used for downstream {@link ChannelEvent}'s. This implementation
* If you don't need to preserve the order just use one of the {@link Executor} implementations provided by the static methods of {@link Executors}. * will take care of preserve the order of the events in a {@link Channel}. If you don't need to
* preserve the order just use one of the {@link Executor} implementations provided by the static
* methods of {@link Executors}.
* <br> * <br>
* <br> * <br>
*
* For more informations about how the order is preserved see {@link OrderedMemoryAwareThreadPoolExecutor} * For more informations about how the order is preserved see {@link OrderedMemoryAwareThreadPoolExecutor}
*
*/ */
public final class OrderedDownstreamThreadPoolExecutor extends OrderedMemoryAwareThreadPoolExecutor { public final class OrderedDownstreamThreadPoolExecutor extends OrderedMemoryAwareThreadPoolExecutor {
@ -83,7 +83,8 @@ public final class OrderedDownstreamThreadPoolExecutor extends OrderedMemoryAwar
} }
/** /**
* Throws {@link UnsupportedOperationException} as there is not support for limit the memory size in this implementation * Throws {@link UnsupportedOperationException} as there is not support for limit the memory
* size in this implementation
*/ */
@Override @Override
public void setObjectSizeEstimator(ObjectSizeEstimator objectSizeEstimator) { public void setObjectSizeEstimator(ObjectSizeEstimator objectSizeEstimator) {
@ -99,7 +100,8 @@ public final class OrderedDownstreamThreadPoolExecutor extends OrderedMemoryAwar
} }
/** /**
* Throws {@link UnsupportedOperationException} as there is not support for limit the memory size in this implementation * Throws {@link UnsupportedOperationException} as there is not support for limit the memory
* size in this implementation
*/ */
@Override @Override
public void setMaxChannelMemorySize(long maxChannelMemorySize) { public void setMaxChannelMemorySize(long maxChannelMemorySize) {
@ -115,7 +117,8 @@ public final class OrderedDownstreamThreadPoolExecutor extends OrderedMemoryAwar
} }
/** /**
* Throws {@link UnsupportedOperationException} as there is not support for limit the memory size in this implementation * Throws {@link UnsupportedOperationException} as there is not support for limit the memory
* size in this implementation
*/ */
@Override @Override
public void setMaxTotalMemorySize(long maxTotalMemorySize) { public void setMaxTotalMemorySize(long maxTotalMemorySize) {

View File

@ -125,7 +125,7 @@ import org.jboss.netty.util.internal.QueueFactory;
* </pre> * </pre>
* *
* If the expected maximum number of keys is small and deterministic, you could * If the expected maximum number of keys is small and deterministic, you could
* use a weak key map such as <a href="http://viewvc.jboss.org/cgi-bin/viewvc.cgi/jbosscache/experimental/jsr166/src/jsr166y/ConcurrentWeakHashMap.java?view=markup">ConcurrentWeakHashMap</a> * use a weak key map such as <a href="http://goo.gl/TqGl1">ConcurrentWeakHashMap</a>
* or synchronized {@link WeakHashMap} instead of managing the life cycle of the * or synchronized {@link WeakHashMap} instead of managing the life cycle of the
* keys by yourself. * keys by yourself.
* *

View File

@ -30,7 +30,8 @@ import org.jboss.netty.channel.ChannelHandlerContext;
* Implementation of Filter of IP based on ALLOW and DENY rules.<br> * Implementation of Filter of IP based on ALLOW and DENY rules.<br>
* <br><br> * <br><br>
* This implementation could be changed by implementing a new {@link IpFilterRule} than default * This implementation could be changed by implementing a new {@link IpFilterRule} than default
* {@link IpV4SubnetFilterRule} (IPV4 support only), {@link IpSubnetFilterRule} (IPV4 and IPV6 support) or {@link IpFilterRule} (IP and host name string pattern support) .<br> * {@link IpV4SubnetFilterRule} (IPV4 support only), {@link IpSubnetFilterRule} (IPV4 and IPV6 support)
* or {@link IpFilterRule} (IP and host name string pattern support) .<br>
* <br> * <br>
* The check is done by going from step to step in the underlying array of IpFilterRule.<br> * The check is done by going from step to step in the underlying array of IpFilterRule.<br>
* Each {@link IpFilterRule} answers to the method accept if the {@link InetAddress} is accepted or not, * Each {@link IpFilterRule} answers to the method accept if the {@link InetAddress} is accepted or not,

View File

@ -18,17 +18,20 @@
* Implementation of a Ip based Filter handlers.<br> * Implementation of a Ip based Filter handlers.<br>
* <br><br> * <br><br>
* <P>The main goal of this package is to allow to filter connections based on IP rules. * <P>The main goal of this package is to allow to filter connections based on IP rules.
* The main interface is <tt>{@link org.jboss.netty.handler.ipfilter.IpFilteringHandler}</tt> which all filters will extend.</P> * The main interface is <tt>{@link org.jboss.netty.handler.ipfilter.IpFilteringHandler}</tt> which
* all filters will extend.</P>
* *
* <P>Two IP filtering are proposed:<br> * <P>Two IP filtering are proposed:<br>
* <ul> * <ul>
* <li> <tt>{@link org.jboss.netty.handler.ipfilter.OneIpFilterHandler}</tt>: This filter proposes to allow only one connection by client's IP Address. * <li>{@link org.jboss.netty.handler.ipfilter.OneIpFilterHandler}: This filter proposes to allow
* I.E. this filter will prevent two connections from the same client based on its IP address.</li><br><br> * only one connection by client's IP Address. I.E. this filter will prevent two connections
* from the same client based on its IP address.</li><br><br>
* *
* <li> <tt>{@link org.jboss.netty.handler.ipfilter.IpFilterRuleHandler}</tt>: This filter proposes to allow or block IP range (based on standard notation * <li>{@link org.jboss.netty.handler.ipfilter.IpFilterRuleHandler}: This filter proposes to allow
* or on CIDR notation) when the connection is running. It relies on another class like * or block IP range (based on standard notation or on CIDR notation) when the connection is
* <tt>IpV4SubnetFilterRule</tt> (IPV4 support only), <tt>IpSubnetFilterRule</tt> (IPV4 and IPV6 support) or <tt>PatternRule</tt> (string pattern support) * running. It relies on another class like <tt>IpV4SubnetFilterRule</tt> (IPV4 support only),
* which implements those Ip ranges.</li><br><br> * <tt>IpSubnetFilterRule</tt> (IPV4 and IPV6 support) or <tt>PatternRule</tt> (string pattern
* support) which implements those Ip ranges.</li><br><br>
* *
* </ul></P> * </ul></P>
* *
@ -42,27 +45,32 @@
* this method is already implemented.<br> * this method is already implemented.<br>
* <br> * <br>
* *
* <li><tt>handleRefusedChannel</tt> method is executed when the accept method filters (blocks, so returning false) * <li>handleRefusedChannel method is executed when the accept method filters (blocks, so returning
* the new connection. This method allows you to implement specific actions to be taken before the channel is * false) the new connection. This method allows you to implement specific actions to be taken
* closed. After this method is called, the channel is immediately closed.</li><br> * before the channel is closed. After this method is called, the channel is immediately closed.</li><br>
* So if you want to send back a message to the client, <b>don't forget to return a respectful ChannelFuture, *
* otherwise the message could be missed since the channel will be closed immediately after this * So if you want to send back a message to the client, <b>don't forget to return a respectful
* call and the waiting on this channelFuture</b> (at least with respect of asynchronous operations).<br><br> * ChannelFuture, otherwise the message could be missed since the channel will be closed immediately
* Per default implementation this method invokes an {@link org.jboss.netty.handler.ipfilter.IpFilterListener} or returns null if no listener has been set. * after this call and the waiting on this channelFuture</b> (at least with respect of asynchronous
* operations).<br><br>
* Per default implementation this method invokes an {@link org.jboss.netty.handler.ipfilter.IpFilterListener}
* or returns null if no listener has been set.
* <br><br> * <br><br>
* *
* <li><tt>continues</tt> is called when any event appears after CONNECTED event and only for * <li><tt>continues</tt> is called when any event appears after CONNECTED event and only for
* blocked channels.</li><br> * blocked channels.</li><br>
* It should return True if this new event has to go to next handlers * It should return True if this new event has to go to next handlers
* in the pipeline if any, and False (default) if no events has to be passed to the next * in the pipeline if any, and False (default) if no events has to be passed to the next
* handlers when a channel is blocked. This is intend to prevent any unnecessary action since the connection is refused.<br> * handlers when a channel is blocked. This is intend to prevent any unnecessary action since the
* connection is refused.<br>
* However, you could change its behavior for instance because you don't want that any event * However, you could change its behavior for instance because you don't want that any event
* will be blocked by this filter by returning always true or according to some events.<br> * will be blocked by this filter by returning always true or according to some events.<br>
* <b>Note that OPENED and BOUND events are still passed to the next entry in the pipeline since * <b>Note that OPENED and BOUND events are still passed to the next entry in the pipeline since
* those events come out before the CONNECTED event, so there is no possibility to filter those two events * those events come out before the CONNECTED event, so there is no possibility to filter those two events
* before the CONNECTED event shows up. Therefore, you might want to let CLOSED and UNBOUND be passed * before the CONNECTED event shows up. Therefore, you might want to let CLOSED and UNBOUND be passed
* to the next entry in the pipeline.</b><br><br> * to the next entry in the pipeline.</b><br><br>
* Per default implementation this method invokes an {@link org.jboss.netty.handler.ipfilter.IpFilterListener} or returns false if no listener has been set. * Per default implementation this method invokes an {@link org.jboss.netty.handler.ipfilter.IpFilterListener}
* or returns false if no listener has been set.
* <br><br> * <br><br>
* *
* <li>Finally <tt>handleUpstream</tt> traps the CONNECTED and DISCONNECTED events.</li><br> * <li>Finally <tt>handleUpstream</tt> traps the CONNECTED and DISCONNECTED events.</li><br>
@ -70,7 +78,8 @@
* then any new events on this channel will be blocked.<br> * then any new events on this channel will be blocked.<br>
* However, you could change its behavior for instance because you don't want that all events * However, you could change its behavior for instance because you don't want that all events
* will be blocked by this filter by testing the result of isBlocked, and if so, * will be blocked by this filter by testing the result of isBlocked, and if so,
* calling <tt>ctx.sendUpstream(e);</tt> after calling the super method or by changing the <tt>continues</tt> method.<br><br> * calling <tt>ctx.sendUpstream(e);</tt> after calling the super method or by changing the
* <tt>continues</tt> method.<br><br>
* </ul></P><br><br> * </ul></P><br><br>
* *

View File

@ -219,7 +219,8 @@ public class BlockingReadHandler<E> extends SimpleChannelUpstreamHandler {
* @throws InterruptedException * @throws InterruptedException
* if the operation has been interrupted * if the operation has been interrupted
*/ */
public ChannelEvent readEvent(long timeout, TimeUnit unit) throws InterruptedException, BlockingReadTimeoutException { public ChannelEvent readEvent(
long timeout, TimeUnit unit) throws InterruptedException, BlockingReadTimeoutException {
detectDeadLock(); detectDeadLock();
if (isClosed()) { if (isClosed()) {
if (getQueue().isEmpty()) { if (getQueue().isEmpty()) {

View File

@ -142,7 +142,8 @@ import org.jboss.netty.util.internal.QueueFactory;
* } * }
* *
* {@literal @Override} * {@literal @Override}
* public void channelInterestChanged({@link ChannelHandlerContext} ctx, {@link ChannelStateEvent} e) throws Exception { * public void channelInterestChanged(
* {@link ChannelHandlerContext} ctx, {@link ChannelStateEvent} e) throws Exception {
* if (e.getChannel().isWritable()) { * if (e.getChannel().isWritable()) {
* flush(); * flush();
* } * }
@ -355,7 +356,8 @@ public class BufferedWriteHandler extends SimpleChannelHandler implements LifeCy
} }
/** /**
* Fail all buffered writes that are left. See <a href="https://github.com/netty/netty/issues/308>#308</a> for more details * Fail all buffered writes that are left. See
* <a href="https://github.com/netty/netty/issues/308>#308</a> for more details.
*/ */
@Override @Override
public void channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { public void channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {
@ -396,7 +398,8 @@ public class BufferedWriteHandler extends SimpleChannelHandler implements LifeCy
} }
/** /**
* Fail all buffered writes that are left. See <a href="https://github.com/netty/netty/issues/308>#308</a> for more details * Fail all buffered writes that are left.
* See <a href="https://github.com/netty/netty/issues/308>#308</a> for more details.
*/ */
public void afterRemove(ChannelHandlerContext ctx) throws Exception { public void afterRemove(ChannelHandlerContext ctx) throws Exception {
Throwable cause = null; Throwable cause = null;

View File

@ -70,9 +70,10 @@ import org.jboss.netty.util.internal.QueueFactory;
* <h3>Handshake</h3> * <h3>Handshake</h3>
* <p> * <p>
* If {@link #isIssueHandshake()} is {@code false} * If {@link #isIssueHandshake()} is {@code false}
* (default) you will need to take care of calling {@link #handshake()} by your own. In most situations were {@link SslHandler} is used in 'client mode' * (default) you will need to take care of calling {@link #handshake()} by your own. In most
* you want to issue a handshake once the connection was established. if {@link #setIssueHandshake(boolean)} is set to <code>true</code> you don't need to * situations were {@link SslHandler} is used in 'client mode' you want to issue a handshake once
* worry about this as the {@link SslHandler} will take care of it. * the connection was established. if {@link #setIssueHandshake(boolean)} is set to <code>true</code>
* you don't need to worry about this as the {@link SslHandler} will take care of it.
* <p> * <p>
* *
* <h3>Renegotiation</h3> * <h3>Renegotiation</h3>
@ -91,7 +92,8 @@ import org.jboss.netty.util.internal.QueueFactory;
* <ul> * <ul>
* <li><a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2009-3555">CVE-2009-3555</a></li> * <li><a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2009-3555">CVE-2009-3555</a></li>
* <li><a href="http://www.ietf.org/rfc/rfc5746.txt">RFC5746</a></li> * <li><a href="http://www.ietf.org/rfc/rfc5746.txt">RFC5746</a></li>
* <li><a href="http://www.oracle.com/technetwork/java/javase/documentation/tlsreadme2-176330.html">Phased Approach to Fixing the TLS Renegotiation Issue</a></li> * <li><a href="http://www.oracle.com/technetwork/java/javase/documentation/tlsreadme2-176330.html">Phased
* Approach to Fixing the TLS Renegotiation Issue</a></li>
* </ul> * </ul>
* *
* <h3>Closing the session</h3> * <h3>Closing the session</h3>
@ -869,7 +871,8 @@ public class SslHandler extends FrameDecoder
if (result.bytesProduced() > 0) { if (result.bytesProduced() > 0) {
outNetBuf.flip(); outNetBuf.flip();
ChannelBuffer msg = ctx.getChannel().getConfig().getBufferFactory().getBuffer(outNetBuf.remaining()); ChannelBuffer msg =
ctx.getChannel().getConfig().getBufferFactory().getBuffer(outNetBuf.remaining());
// Transfer the bytes to the new ChannelBuffer using some safe method that will also // Transfer the bytes to the new ChannelBuffer using some safe method that will also
@ -939,7 +942,8 @@ public class SslHandler extends FrameDecoder
} }
private ChannelBuffer unwrap( private ChannelBuffer unwrap(
ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, int offset, int length) throws SSLException { ChannelHandlerContext ctx, Channel channel,
ChannelBuffer buffer, int offset, int length) throws SSLException {
ByteBuffer inNetBuf = buffer.toByteBuffer(offset, length); ByteBuffer inNetBuf = buffer.toByteBuffer(offset, length);
ByteBuffer outAppBuf = bufferPool.acquireBuffer(); ByteBuffer outAppBuf = bufferPool.acquireBuffer();
@ -1275,7 +1279,8 @@ public class SslHandler extends FrameDecoder
@Override @Override
public void channelConnected(final ChannelHandlerContext ctx, final ChannelStateEvent e) throws Exception { public void channelConnected(final ChannelHandlerContext ctx, final ChannelStateEvent e) throws Exception {
if (issueHandshake) { if (issueHandshake) {
// issue and handshake and add a listener to it which will fire an exception event if an exception was thrown while doing the handshake // issue and handshake and add a listener to it which will fire an exception event if
// an exception was thrown while doing the handshake
handshake().addListener(new ChannelFutureListener() { handshake().addListener(new ChannelFutureListener() {
public void operationComplete(ChannelFuture future) throws Exception { public void operationComplete(ChannelFuture future) throws Exception {

View File

@ -73,7 +73,8 @@ import org.jboss.netty.util.internal.QueueFactory;
* @apiviz.landmark * @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.stream.ChunkedInput oneway - - reads from * @apiviz.has org.jboss.netty.handler.stream.ChunkedInput oneway - - reads from
*/ */
public class ChunkedWriteHandler implements ChannelUpstreamHandler, ChannelDownstreamHandler, LifeCycleAwareChannelHandler { public class ChunkedWriteHandler
implements ChannelUpstreamHandler, ChannelDownstreamHandler, LifeCycleAwareChannelHandler {
private static final InternalLogger logger = private static final InternalLogger logger =
InternalLoggerFactory.getInstance(ChunkedWriteHandler.class); InternalLoggerFactory.getInstance(ChunkedWriteHandler.class);
@ -251,8 +252,9 @@ public class ChunkedWriteHandler implements ChannelUpstreamHandler, ChannelDowns
this.currentEvent = null; this.currentEvent = null;
writeFuture = currentEvent.getFuture(); writeFuture = currentEvent.getFuture();
// Register a listener which will close the input once the write is complete. This is needed because the Chunk may have // Register a listener which will close the input once the write
// some resource bound that can not be closed before its not written // is complete. This is needed because the Chunk may have some
// resource bound that can not be closed before its not written
// //
// See https://github.com/netty/netty/issues/303 // See https://github.com/netty/netty/issues/303
writeFuture.addListener(new ChannelFutureListener() { writeFuture.addListener(new ChannelFutureListener() {

View File

@ -25,14 +25,16 @@
* *
* <P>Two classes implement this behavior:<br> * <P>Two classes implement this behavior:<br>
* <ul> * <ul>
* <li> <tt>{@link org.jboss.netty.handler.traffic.TrafficCounter}</tt>: this class implements the counters needed by the handlers. * <li>{@link org.jboss.netty.handler.traffic.TrafficCounter}: this class implements the counters
* It can be accessed to get some extra information like the read or write bytes since last check, the read and write * needed by the handlers. It can be accessed to get some extra information like the read or
* bandwidth from last check...</li><br><br> * write bytes since last check, the read and write bandwidth from last check...</li><br><br>
* *
* <li> <tt>{@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}</tt>: this abstract class implements the kernel * <li>{@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}: this abstract class
* of the traffic shaping. It could be extended to fit your needs. Two classes are proposed as default * implements the kernel of the traffic shaping. It could be extended to fit your needs. Two
* implementations: see {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} and see {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler} * classes are proposed as default implementations: see
* respectively for Channel traffic shaping and Global traffic shaping.</li><br><br> * {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} and
* {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler} respectively for
* Channel traffic shaping and Global traffic shaping.</li><br><br>
* *
* The insertion in the pipeline of one of those handlers can be wherever you want, but * The insertion in the pipeline of one of those handlers can be wherever you want, but
* <b>it must be placed before any <tt>{@link MemoryAwareThreadPoolExecutor}</tt> * <b>it must be placed before any <tt>{@link MemoryAwareThreadPoolExecutor}</tt>
@ -62,14 +64,16 @@
* [Global or per Channel] [Write or Read] Limitation in byte/s.</li><br> * [Global or per Channel] [Write or Read] Limitation in byte/s.</li><br>
* A value of <tt>0</tt> * A value of <tt>0</tt>
* stands for no limitation, so the traffic shaping is deactivate (on what you specified).<br> * stands for no limitation, so the traffic shaping is deactivate (on what you specified).<br>
* You can either change those values with the method <tt>configure</tt> in {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}.<br> * You can either change those values with the method <tt>configure</tt> in
* {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}.<br>
* <br> * <br>
* *
* <li>To activate or deactivate the statistics, you can adjust the delay to a low (suggested not less than 200ms * <li>To activate or deactivate the statistics, you can adjust the delay to a low (suggested not less than 200ms
* for efficiency reasons) or a high value (let say 24H in millisecond is huge enough to not get the problem) * for efficiency reasons) or a high value (let say 24H in millisecond is huge enough to not get the problem)
* or even using <tt>0</tt> which means no computation will be done.</li><br> * or even using <tt>0</tt> which means no computation will be done.</li><br>
* If you want to do anything with this statistics, just override the <tt>doAccounting</tt> method.<br> * If you want to do anything with this statistics, just override the <tt>doAccounting</tt> method.<br>
* This interval can be changed either from the method <tt>configure</tt> in {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler} * This interval can be changed either from the method <tt>configure</tt> in
* {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}
* or directly using the method <tt>configure</tt> of {@link org.jboss.netty.handler.traffic.TrafficCounter}.<br><br> * or directly using the method <tt>configure</tt> of {@link org.jboss.netty.handler.traffic.TrafficCounter}.<br><br>
* *
* </ul></P><br><br> * </ul></P><br><br>
@ -81,8 +85,9 @@
* <tt>pipeline.addLast("XXXXX_TRAFFIC_SHAPING", myHandler);</tt><br> * <tt>pipeline.addLast("XXXXX_TRAFFIC_SHAPING", myHandler);</tt><br>
* <tt>...</tt><br> * <tt>...</tt><br>
* <tt>pipeline.addLast("MemoryExecutor",new ExecutionHandler(memoryAwareThreadPoolExecutor));</tt><br><br> * <tt>pipeline.addLast("MemoryExecutor",new ExecutionHandler(memoryAwareThreadPoolExecutor));</tt><br><br>
* <P>Note that a new {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} must be created for each new channel, * <P>Note that a new {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} must be
* but only one {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler} must be created for all channels.</P> * created for each new channel, but only one {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler}
* must be created for all channels.</P>
* *
* <P>Note also that you can create different GlobalTrafficShapingHandler if you want to separate classes of * <P>Note also that you can create different GlobalTrafficShapingHandler if you want to separate classes of
* channels (for instance either from business point of view or from bind address point of view).</P> * channels (for instance either from business point of view or from bind address point of view).</P>