/usr/share/doc/libservlet3.1-java/api/javax/websocket/Session.html is in libservlet3.1-java-doc 8.5.30-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>Session (Tomcat API Documentation)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Session (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/websocket/SendResult.html" title="class in javax.websocket"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/websocket/SessionException.html" title="class in javax.websocket"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/websocket/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../javax/websocket/package-summary.html">javax.websocket</a></div>
<h2 title="Interface Session" class="title">Interface Session</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code>java.io.Closeable</code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Session</span>
extends java.io.Closeable</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><T> void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Partial-">addMessageHandler</a></span>​(java.lang.Class<T> clazz,
<a href="../../javax/websocket/MessageHandler.Partial.html" title="interface in javax.websocket">MessageHandler.Partial</a><T> handler)</code></th>
<td class="colLast">
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for partial incoming messages.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><T> void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Whole-">addMessageHandler</a></span>​(java.lang.Class<T> clazz,
<a href="../../javax/websocket/MessageHandler.Whole.html" title="interface in javax.websocket">MessageHandler.Whole</a><T> handler)</code></th>
<td class="colLast">
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for whole incoming messages.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#addMessageHandler-javax.websocket.MessageHandler-">addMessageHandler</a></span>​(<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a> handler)</code></th>
<td class="colLast">
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for incoming messages.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#close--">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Close the connection to the remote end point using the code
<a href="../../javax/websocket/CloseReason.CloseCodes.html#NORMAL_CLOSURE"><code>CloseReason.CloseCodes.NORMAL_CLOSURE</code></a> and an
empty reason phrase.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#close-javax.websocket.CloseReason-">close</a></span>​(<a href="../../javax/websocket/CloseReason.html" title="class in javax.websocket">CloseReason</a> closeReason)</code></th>
<td class="colLast">
<div class="block">Close the connection to the remote end point using the specified code
and reason phrase.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../javax/websocket/RemoteEndpoint.Async.html" title="interface in javax.websocket">RemoteEndpoint.Async</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getAsyncRemote--">getAsyncRemote</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../javax/websocket/RemoteEndpoint.Basic.html" title="interface in javax.websocket">RemoteEndpoint.Basic</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getBasicRemote--">getBasicRemote</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../javax/websocket/WebSocketContainer.html" title="interface in javax.websocket">WebSocketContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getContainer--">getContainer</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the container that created this session.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getId--">getId</a></span>()</code></th>
<td class="colLast">
<div class="block">Provides a unique identifier for the session.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getMaxBinaryMessageBufferSize--">getMaxBinaryMessageBufferSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the current maximum buffer size for binary messages.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getMaxIdleTimeout--">getMaxIdleTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the idle timeout for this session.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getMaxTextMessageBufferSize--">getMaxTextMessageBufferSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the maximum buffer size for text messages.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getMessageHandlers--">getMessageHandlers</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getNegotiatedExtensions--">getNegotiatedExtensions</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getNegotiatedSubprotocol--">getNegotiatedSubprotocol</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.Set<<a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getOpenSessions--">getOpenSessions</a></span>()</code></th>
<td class="colLast">
<div class="block">Obtain the set of open sessions associated with the same local endpoint
as this session.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getPathParameters--">getPathParameters</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getProtocolVersion--">getProtocolVersion</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getQueryString--">getQueryString</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.util.Map<java.lang.String,java.util.List<java.lang.String>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getRequestParameterMap--">getRequestParameterMap</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getRequestURI--">getRequestURI</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.security.Principal</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getUserPrincipal--">getUserPrincipal</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#getUserProperties--">getUserProperties</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#isOpen--">isOpen</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#isSecure--">isSecure</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#removeMessageHandler-javax.websocket.MessageHandler-">removeMessageHandler</a></span>​(<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a> listener)</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#setMaxBinaryMessageBufferSize-int-">setMaxBinaryMessageBufferSize</a></span>​(int max)</code></th>
<td class="colLast">
<div class="block">Set the current maximum buffer size for binary messages.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#setMaxIdleTimeout-long-">setMaxIdleTimeout</a></span>​(long timeout)</code></th>
<td class="colLast">
<div class="block">Set the idle timeout for this session.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/websocket/Session.html#setMaxTextMessageBufferSize-int-">setMaxTextMessageBufferSize</a></span>​(int max)</code></th>
<td class="colLast">
<div class="block">Set the maximum buffer size for text messages.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContainer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainer</h4>
<pre><a href="../../javax/websocket/WebSocketContainer.html" title="interface in javax.websocket">WebSocketContainer</a> getContainer()</pre>
<div class="block">Get the container that created this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the container that created this session.</dd>
</dl>
</li>
</ul>
<a name="addMessageHandler-javax.websocket.MessageHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMessageHandler</h4>
<pre>void addMessageHandler​(<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a> handler)
throws java.lang.IllegalStateException</pre>
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for incoming messages. Only one
<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> may be registered for each message type (text,
binary, pong). The message type will be derived at runtime from the
provided <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> instance. It is not always possible to do
this so it is better to use
<a href="../../javax/websocket/Session.html#addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Partial-"><code>addMessageHandler(Class, javax.websocket.MessageHandler.Partial)</code></a>
or
<a href="../../javax/websocket/Session.html#addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Whole-"><code>addMessageHandler(Class, javax.websocket.MessageHandler.Whole)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - The message handler for a incoming message</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If a message handler has already been
registered for the associated message type</dd>
</dl>
</li>
</ul>
<a name="getMessageHandlers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageHandlers</h4>
<pre>java.util.Set<<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a>> getMessageHandlers()</pre>
</li>
</ul>
<a name="removeMessageHandler-javax.websocket.MessageHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMessageHandler</h4>
<pre>void removeMessageHandler​(<a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket">MessageHandler</a> listener)</pre>
</li>
</ul>
<a name="getProtocolVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolVersion</h4>
<pre>java.lang.String getProtocolVersion()</pre>
</li>
</ul>
<a name="getNegotiatedSubprotocol--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedSubprotocol</h4>
<pre>java.lang.String getNegotiatedSubprotocol()</pre>
</li>
</ul>
<a name="getNegotiatedExtensions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedExtensions</h4>
<pre>java.util.List<<a href="../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>> getNegotiatedExtensions()</pre>
</li>
</ul>
<a name="isSecure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre>boolean isSecure()</pre>
</li>
</ul>
<a name="isOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>boolean isOpen()</pre>
</li>
</ul>
<a name="getMaxIdleTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIdleTimeout</h4>
<pre>long getMaxIdleTimeout()</pre>
<div class="block">Get the idle timeout for this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current idle timeout for this session in milliseconds. Zero
or negative values indicate an infinite timeout.</dd>
</dl>
</li>
</ul>
<a name="setMaxIdleTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxIdleTimeout</h4>
<pre>void setMaxIdleTimeout​(long timeout)</pre>
<div class="block">Set the idle timeout for this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The new idle timeout for this session in milliseconds.
Zero or negative values indicate an infinite timeout.</dd>
</dl>
</li>
</ul>
<a name="setMaxBinaryMessageBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBinaryMessageBufferSize</h4>
<pre>void setMaxBinaryMessageBufferSize​(int max)</pre>
<div class="block">Set the current maximum buffer size for binary messages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>max</code> - The new maximum buffer size in bytes</dd>
</dl>
</li>
</ul>
<a name="getMaxBinaryMessageBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBinaryMessageBufferSize</h4>
<pre>int getMaxBinaryMessageBufferSize()</pre>
<div class="block">Get the current maximum buffer size for binary messages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current maximum buffer size in bytes</dd>
</dl>
</li>
</ul>
<a name="setMaxTextMessageBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTextMessageBufferSize</h4>
<pre>void setMaxTextMessageBufferSize​(int max)</pre>
<div class="block">Set the maximum buffer size for text messages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>max</code> - The new maximum buffer size in characters.</dd>
</dl>
</li>
</ul>
<a name="getMaxTextMessageBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTextMessageBufferSize</h4>
<pre>int getMaxTextMessageBufferSize()</pre>
<div class="block">Get the maximum buffer size for text messages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The maximum buffer size in characters.</dd>
</dl>
</li>
</ul>
<a name="getAsyncRemote--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsyncRemote</h4>
<pre><a href="../../javax/websocket/RemoteEndpoint.Async.html" title="interface in javax.websocket">RemoteEndpoint.Async</a> getAsyncRemote()</pre>
</li>
</ul>
<a name="getBasicRemote--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBasicRemote</h4>
<pre><a href="../../javax/websocket/RemoteEndpoint.Basic.html" title="interface in javax.websocket">RemoteEndpoint.Basic</a> getBasicRemote()</pre>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String getId()</pre>
<div class="block">Provides a unique identifier for the session. This identifier should not
be relied upon to be generated from a secure random source.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A unique identifier for the session.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void close()
throws java.io.IOException</pre>
<div class="block">Close the connection to the remote end point using the code
<a href="../../javax/websocket/CloseReason.CloseCodes.html#NORMAL_CLOSURE"><code>CloseReason.CloseCodes.NORMAL_CLOSURE</code></a> and an
empty reason phrase.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while the WebSocket session is
being closed.</dd>
</dl>
</li>
</ul>
<a name="close-javax.websocket.CloseReason-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void close​(<a href="../../javax/websocket/CloseReason.html" title="class in javax.websocket">CloseReason</a> closeReason)
throws java.io.IOException</pre>
<div class="block">Close the connection to the remote end point using the specified code
and reason phrase.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>closeReason</code> - The reason the WebSocket session is being closed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while the WebSocket session is
being closed.</dd>
</dl>
</li>
</ul>
<a name="getRequestURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestURI</h4>
<pre>java.net.URI getRequestURI()</pre>
</li>
</ul>
<a name="getRequestParameterMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestParameterMap</h4>
<pre>java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestParameterMap()</pre>
</li>
</ul>
<a name="getQueryString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryString</h4>
<pre>java.lang.String getQueryString()</pre>
</li>
</ul>
<a name="getPathParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathParameters</h4>
<pre>java.util.Map<java.lang.String,java.lang.String> getPathParameters()</pre>
</li>
</ul>
<a name="getUserProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserProperties</h4>
<pre>java.util.Map<java.lang.String,java.lang.Object> getUserProperties()</pre>
</li>
</ul>
<a name="getUserPrincipal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPrincipal</h4>
<pre>java.security.Principal getUserPrincipal()</pre>
</li>
</ul>
<a name="getOpenSessions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpenSessions</h4>
<pre>java.util.Set<<a href="../../javax/websocket/Session.html" title="interface in javax.websocket">Session</a>> getOpenSessions()</pre>
<div class="block">Obtain the set of open sessions associated with the same local endpoint
as this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The set of currently open sessions for the local endpoint that
this session is associated with.</dd>
</dl>
</li>
</ul>
<a name="addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Partial-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMessageHandler</h4>
<pre><T> void addMessageHandler​(java.lang.Class<T> clazz,
<a href="../../javax/websocket/MessageHandler.Partial.html" title="interface in javax.websocket">MessageHandler.Partial</a><T> handler)
throws java.lang.IllegalStateException</pre>
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for partial incoming messages. Only
one <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> may be registered for each message type (text
or binary, pong messages are never presented as partial messages).</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of message that the given handler is intended
for</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - The Class that implements T</dd>
<dd><code>handler</code> - The message handler for a incoming message</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If a message handler has already been
registered for the associated message type</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>WebSocket 1.1</dd>
</dl>
</li>
</ul>
<a name="addMessageHandler-java.lang.Class-javax.websocket.MessageHandler.Whole-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addMessageHandler</h4>
<pre><T> void addMessageHandler​(java.lang.Class<T> clazz,
<a href="../../javax/websocket/MessageHandler.Whole.html" title="interface in javax.websocket">MessageHandler.Whole</a><T> handler)
throws java.lang.IllegalStateException</pre>
<div class="block">Registers a <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> for whole incoming messages. Only
one <a href="../../javax/websocket/MessageHandler.html" title="interface in javax.websocket"><code>MessageHandler</code></a> may be registered for each message type (text,
binary, pong).</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of message that the given handler is intended
for</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - The Class that implements T</dd>
<dd><code>handler</code> - The message handler for a incoming message</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If a message handler has already been
registered for the associated message type</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>WebSocket 1.1</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/websocket/SendResult.html" title="class in javax.websocket"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/websocket/SessionException.html" title="class in javax.websocket"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/websocket/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2000-2016 The Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|