documentation link fixes and use of static loggers

Signed-off-by: lachan-roberts <lachlan@webtide.com>
This commit is contained in:
lachan-roberts 2019-04-29 13:56:33 +10:00 committed by Greg Wilkins
parent 8360aad619
commit c5cb2170aa
3 changed files with 5 additions and 5 deletions

View File

@ -31,7 +31,7 @@ To wire up your WebSocket to a specific path via the WebSocketServlet, you will
[source, java, subs="{sub-order}"] [source, java, subs="{sub-order}"]
---- ----
include::{SRCDIR}/jetty-websocket/websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyEchoServlet.java[] include::{SRCDIR}/jetty-websocket/jetty-websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyEchoServlet.java[]
---- ----
This example will create a Servlet mapped via the http://docs.oracle.com/javaee/6/api/javax/servlet/annotation/WebServlet.html[@WebServlet] annotation to the Servlet path spec of `"/echo"` (or you can do this manually in the `WEB-INF/web.xml` of your web application) which will create MyEchoSocket instances when encountering HTTP Upgrade requests. This example will create a Servlet mapped via the http://docs.oracle.com/javaee/6/api/javax/servlet/annotation/WebServlet.html[@WebServlet] annotation to the Servlet path spec of `"/echo"` (or you can do this manually in the `WEB-INF/web.xml` of your web application) which will create MyEchoSocket instances when encountering HTTP Upgrade requests.
@ -57,7 +57,7 @@ If you have a more complicated creation scenario, you might want to provide your
[source, java, subs="{sub-order}"] [source, java, subs="{sub-order}"]
---- ----
include::{SRCDIR}/jetty-websocket/websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyAdvancedEchoCreator.java[] include::{SRCDIR}/jetty-websocket/jetty-websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyAdvancedEchoCreator.java[]
---- ----
Here we show a WebSocketCreator that will utilize the http://tools.ietf.org/html/rfc6455#section-1.9[WebSocket subprotocol] information from request to determine what WebSocket type should be Here we show a WebSocketCreator that will utilize the http://tools.ietf.org/html/rfc6455#section-1.9[WebSocket subprotocol] information from request to determine what WebSocket type should be
@ -65,7 +65,7 @@ created.
[source, java, subs="{sub-order}"] [source, java, subs="{sub-order}"]
---- ----
include::{SRCDIR}/jetty-websocket/websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyAdvancedEchoServlet.java[] include::{SRCDIR}/jetty-websocket/jetty-websocket-tests/src/test/java/org/eclipse/jetty/websocket/tests/examples/MyAdvancedEchoServlet.java[]
---- ----
When you want a custom WebSocketCreator, use link:{JDURL}/org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#setCreator(org.eclipse.jetty.websocket.servlet.WebSocketCreator)[`WebSocketServletFactory.setCreator(WebSocketCreator creator)`] and the WebSocketServletFactory will use your creator for all incoming Upgrade requests on this servlet. When you want a custom WebSocketCreator, use link:{JDURL}/org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#setCreator(org.eclipse.jetty.websocket.servlet.WebSocketCreator)[`WebSocketServletFactory.setCreator(WebSocketCreator creator)`] and the WebSocketServletFactory will use your creator for all incoming Upgrade requests on this servlet.

View File

@ -60,7 +60,7 @@ import static org.eclipse.jetty.util.Callback.NOOP;
*/ */
public class WebSocketChannel implements IncomingFrames, FrameHandler.CoreSession, Dumpable public class WebSocketChannel implements IncomingFrames, FrameHandler.CoreSession, Dumpable
{ {
private Logger LOG = Log.getLogger(this.getClass()); private static final Logger LOG = Log.getLogger(WebSocketChannel.class);
private final static CloseStatus NO_CODE = new CloseStatus(CloseStatus.NO_CODE); private final static CloseStatus NO_CODE = new CloseStatus(CloseStatus.NO_CODE);
private final Behavior behavior; private final Behavior behavior;

View File

@ -47,7 +47,7 @@ import org.eclipse.jetty.websocket.core.WebSocketTimeoutException;
*/ */
public class WebSocketConnection extends AbstractConnection implements Connection.UpgradeTo, Dumpable, Runnable public class WebSocketConnection extends AbstractConnection implements Connection.UpgradeTo, Dumpable, Runnable
{ {
private final Logger LOG = Log.getLogger(this.getClass()); private static final Logger LOG = Log.getLogger(WebSocketConnection.class);
/** /**
* Minimum size of a buffer is the determined to be what would be the maximum framing header size (not including payload) * Minimum size of a buffer is the determined to be what would be the maximum framing header size (not including payload)