| <html><head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| <title>WebSocket Events</title><link rel="stylesheet" type="text/css" href="css/docbook.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"><meta name="keywords" content="jetty, servlet, servlet-api, cometd, http, websocket, eclipse, maven, java, server, software"><link rel="home" href="index.html" title="Jetty : The Definitive Reference"><link rel="up" href="websocket-jetty.html" title="Chapter 29. Jetty Websocket API"><link rel="prev" href="websocket-jetty.html" title="Chapter 29. Jetty Websocket API"><link rel="next" href="jetty-websocket-api-session.html" title="WebSocket Session"><link xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" rel="shortcut icon" href="images/favicon.ico"><script type="text/javascript" src="js/shCore.js"></script><script type="text/javascript" src="js/shBrushJava.js"></script><script type="text/javascript" src="js/shBrushXml.js"></script><script type="text/javascript" src="js/shBrushBash.js"></script><script type="text/javascript" src="js/shBrushJScript.js"></script><script type="text/javascript" src="js/shBrushSql.js"></script><script type="text/javascript" src="js/shBrushProperties.js"></script><script type="text/javascript" src="js/shBrushPlain.js"></script><link type="text/css" rel="stylesheet" href="css/shCore.css"><link type="text/css" rel="stylesheet" href="css/shThemeEclipse.css"><link type="text/css" rel="stylesheet" href="css/font-awesome.min.css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><tr><td style="width: 25%"><a href="http://www.eclipse.org/jetty"><img src="images/jetty-header-logo.png" alt="Jetty Logo"></a><br><span style="font-size: small"> | |
| Version: 9.3.0.v20150612</span></td><td style="width: 50%"><script type="text/javascript"> (function() { | |
| var cx = '016459005284625897022:obd4lsai2ds'; | |
| var gcse = document.createElement('script'); | |
| gcse.type = 'text/javascript'; | |
| gcse.async = true; | |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + | |
| '//www.google.com/cse/cse.js?cx=' + cx; | |
| var s = document.getElementsByTagName('script')[0]; | |
| s.parentNode.insertBefore(gcse, s); | |
| })(); | |
| </script><gcse:search></gcse:search></td></tr></table><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">WebSocket Events</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="websocket-jetty.html"><i class="icon-chevron-left"></i> Previous</a> </td><th width="60%" align="center">Chapter 29. Jetty Websocket API<br><a accesskey="p" href="index.html"><i class="icon-home"></i> Home</a></th><td width="20%" align="right"> <a accesskey="n" href="jetty-websocket-api-session.html">Next <i class="icon-chevron-right"></i></a></td></tr></table><hr></div><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="jetty-callout"><h5 class="callout"><a href="http://www.webtide.com/">Contact the core Jetty developers at | |
| <span class="website">www.webtide.com</span></a></h5><p> | |
| private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... | |
| scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery | |
| </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="jetty-websocket-api-events"></a>WebSocket Events</h2></div></div></div><p>Every WebSocket can receive various events:</p><div class="variablelist"><dl><dt><span class="term">On Connect Event</span></dt><dd><p>An indication to the WebSocket that the Upgrade has succeeded | |
| and the WebSocket is now open.</p><p>You will receive a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/websocket/api/Session.html" target="_top"><code class="classname">org.eclipse.jetty.websocket.api.Session</code></a> | |
| object that references the specific session for this Open | |
| Event.</p><p>For normal WebSockets, it is important to hold onto this | |
| Session and use it for communicating with the Remote | |
| Endpoint.</p><p>For Stateless WebSockets, the Session will be passed into each | |
| event as it occurs, allowing you to only have 1 instance of a | |
| WebSocket serving many Remote Endpoints.</p></dd><dt><span class="term">On Close Event</span></dt><dd><p>An indication that the WebSocket is now closed.</p><p>Every Close Event will have a <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/websocket/api/StatusCode.html" target="_top">Status | |
| Code</a> (and an optional Closure Reason Message)</p><p>A normal WebSocket closure will go through a Close Handshake | |
| where both the Local Endpoint and the Remote Endpoint both send a | |
| Close frame to indicate that the connection is closed.</p><p>It is possible for the Local WebSocket to indicate its desire | |
| to Close by issuing a Close frame to the Remote Endpoint, but the | |
| Remote Endpoint can continue to send messages until it sends a Close | |
| Frame. This is known as a Half-Open connection, and it is important | |
| to note that once the Local Endpoint has send the Close Frame it | |
| cannot write anymore WebSocket traffic.</p><p>On an abnormal closure, such as a connection disconnect or a | |
| connection timeout, the low level connection will be terminated | |
| without going through a Close Handshake, this will still result in | |
| an On Close Event (and likely a corresponding On Error | |
| Event).</p></dd><dt><span class="term">On Error Event</span></dt><dd><p>If an error occurred, during the implementation, the WebSocket | |
| will be notified via this event handler.</p></dd><dt><span class="term">On Message Event</span></dt><dd><p>An indication that a complete message has been received and is | |
| ready for handling by your WebSocket.</p><p>This can be a (UTF8) TEXT message or a raw BINARY | |
| message.</p></dd></dl></div></div><script type="text/javascript"> | |
| SyntaxHighlighter.all() | |
| </script><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="websocket-jetty.html"><i class="icon-chevron-left"></i> Previous</a> </td><td width="20%" align="center"><a accesskey="u" href="websocket-jetty.html"><i class="icon-chevron-up"></i> Top</a></td><td width="40%" align="right"> <a accesskey="n" href="jetty-websocket-api-session.html">Next <i class="icon-chevron-right"></i></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 29. Jetty Websocket API </td><td width="20%" align="center"><a accesskey="h" href="index.html"><i class="icon-home"></i> Home</a></td><td width="40%" align="right" valign="top"> WebSocket Session</td></tr></table></div><p xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><div class="jetty-callout"> | |
| See an error or something missing? | |
| <span class="callout"><a href="http://github.com/jetty-project/jetty-documentation">Contribute to this documentation at | |
| <span class="website"><i class="icon-github"></i> Github!</span></a></span><span style="float: right"><i>(Generated: 2015-06-15T13:18:47-05:00)</i></span></div></p><script xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" type="text/javascript"> | |
| var _gaq = _gaq || []; | |
| _gaq.push(['_setAccount', 'UA-1149868-7']); | |
| _gaq.push(['_trackPageview']); | |
| (function() { | |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; | |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; | |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); | |
| })(); | |
| </script></body></html> |