38 lines
6.0 KiB
HTML
38 lines
6.0 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>WebSocketMessageHandler (handy_http_websockets.components.WebSocketMessageHandler)</title>
|
|
<meta charset="utf-8" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<script src="script.js" type="text/javascript"></script>
|
|
|
|
|
|
<link href="search-results.html" rel="prefetch" />
|
|
</head>
|
|
<body>
|
|
<div id="page-header">
|
|
<div id="logotype">
|
|
<span>Documentation</span>
|
|
<nav>
|
|
<a href="http://dlang.org/">Dlang.org</a>
|
|
</nav>
|
|
</div>
|
|
|
|
<form action="search-docs.html" id="search">
|
|
<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
<div id="page-body">
|
|
<div id="page-content">
|
|
<h1>WebSocketMessageHandler</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_websockets.html">handy_http_websockets</a> <a class="breadcrumb" href="handy_http_websockets.components.html">components</a> </div><div><div class="documentation-comment synopsis"><div><p>An abstract class that you should extend to define logic for handling
|
|
websocket messages and events. Create a new class that inherits from this
|
|
one, and overrides any "on..." methods that you'd like.</p></div></div></div><div class="annotated-prototype"><div class="aggregate-prototype"><div class="attributes">abstract </div><span class="builtin-type">class</span> WebSocketMessageHandler {<div class="aggregate-member"><a href="handy_http_websockets.components.WebSocketMessageHandler.onConnectionEstablished.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onConnectionEstablished</span>(WebSocketConnection conn, ServerHttpRequest request);</a></div><div class="aggregate-member"><a href="handy_http_websockets.components.WebSocketMessageHandler.onTextMessage.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onTextMessage</span>(WebSocketTextMessage msg);</a></div><div class="aggregate-member"><a href="handy_http_websockets.components.WebSocketMessageHandler.onBinaryMessage.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onBinaryMessage</span>(WebSocketBinaryMessage msg);</a></div><div class="aggregate-member"><a href="handy_http_websockets.components.WebSocketMessageHandler.onCloseMessage.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onCloseMessage</span>(WebSocketCloseMessage msg);</a></div><div class="aggregate-member"><a href="handy_http_websockets.components.WebSocketMessageHandler.onConnectionClosed.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onConnectionClosed</span>(WebSocketConnection conn);</a></div>}</div></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="function"><a class="header-anchor" href="#function">Functions</a></h3><dl class="member-list native"><dt><a href="handy_http_websockets.components.WebSocketMessageHandler.onBinaryMessage.html">onBinaryMessage</a><div class="simplified-prototype" style="max-width: 52ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onBinaryMessage</span>(WebSocketBinaryMessage msg)</div></dt><dd><div><p>Called when a binary message is received.</p></div></dd><dt><a href="handy_http_websockets.components.WebSocketMessageHandler.onCloseMessage.html">onCloseMessage</a><div class="simplified-prototype" style="max-width: 50ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onCloseMessage</span>(WebSocketCloseMessage msg)</div></dt><dd><div><p>Called when a CLOSE message is received. Note that this is called before
|
|
the socket is necessarily guaranteed to be closed.</p></div></dd><dt><a href="handy_http_websockets.components.WebSocketMessageHandler.onConnectionClosed.html">onConnectionClosed</a><div class="simplified-prototype" style="max-width: 53ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onConnectionClosed</span>(WebSocketConnection conn)</div></dt><dd><div><p>Called when a websocket connection is closed.</p></div></dd><dt><a href="handy_http_websockets.components.WebSocketMessageHandler.onConnectionEstablished.html">onConnectionEstablished</a><div class="simplified-prototype" style="max-width: 89ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onConnectionEstablished</span>(WebSocketConnection conn, ServerHttpRequest request)</div></dt><dd><div><p>Called when a new websocket connection is established.</p></div></dd><dt><a href="handy_http_websockets.components.WebSocketMessageHandler.onTextMessage.html">onTextMessage</a><div class="simplified-prototype" style="max-width: 48ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">onTextMessage</span>(WebSocketTextMessage msg)</div></dt><dd><div><p>Called when a text message is received.</p></div></dd></dl><div></div></div>
|
|
<div id="page-nav"><a class="parent" href="handy_http_websockets.html">handy_http_websockets</a> <a class="parent" href="handy_http_websockets.components.html">components</a>
|
|
<span class="type-separator">classes</span><ul><li><a class="class" href="handy_http_websockets.components.WebSocketException.html">WebSocketException</a></li><li><a class="class current" href="handy_http_websockets.components.WebSocketMessageHandler.html">WebSocketMessageHandler</a></li></ul><span class="type-separator">structs</span><ul><li><a class="struct" href="handy_http_websockets.components.WebSocketBinaryMessage.html">WebSocketBinaryMessage</a></li><li><a class="struct" href="handy_http_websockets.components.WebSocketCloseMessage.html">WebSocketCloseMessage</a></li><li><a class="struct" href="handy_http_websockets.components.WebSocketTextMessage.html">WebSocketTextMessage</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |