| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SseBroadcaster</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SseBroadcaster"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= 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="../../../../jakarta/ws/rs/sse/Sse.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/sse/SseEvent.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/sse/SseBroadcaster.html" target="_top">Frames</a></li> |
| <li><a href="SseBroadcaster.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> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ws.rs.sse</div> |
| <h2 title="Interface SseBroadcaster" class="title">Interface SseBroadcaster</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SseBroadcaster</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">Server-Sent events broadcasting facility. |
| <p> |
| Server broadcaster can be used to manage multiple <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>server sinks</code></a>. It enables sending events to all |
| registered event outputs and provides facility to effectively handle exceptions and closures of individual registered |
| event outputs. |
| <p> |
| Instance of this interface is thread safe, meaning that it can be shared and its method invoked from different |
| threads without causing inconsistent internal state.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </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" border="0" cellpadding="3" cellspacing="0" 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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.CompletionStage<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html#broadcast-jakarta.ws.rs.sse.OutboundSseEvent-">broadcast</a></span>(<a href="../../../../jakarta/ws/rs/sse/OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a> event)</code> |
| <div class="block">Publish an SSE event to all registered <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html#close--">close</a></span>()</code> |
| <div class="block">Close the broadcaster and all registered <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html#onClose-java.util.function.Consumer-">onClose</a></span>(java.util.function.Consumer<<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>> onClose)</code> |
| <div class="block">Register a listener, which will be called when the SSE event output has been closed (either by client closing the |
| connection or by calling <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html#close--"><code>SseEventSink.close()</code></a> on the server side.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html#onError-java.util.function.BiConsumer-">onError</a></span>(java.util.function.BiConsumer<<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,java.lang.Throwable> onError)</code> |
| <div class="block">Register a listener, which will be called when an exception was thrown by a given SSE event output when trying to |
| write to it or close it.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html#register-jakarta.ws.rs.sse.SseEventSink-">register</a></span>(<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a> sseEventSink)</code> |
| <div class="block">Register provided <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instance to this <code>SseBroadcaster</code>.</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="onError-java.util.function.BiConsumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onError</h4> |
| <pre>void onError(java.util.function.BiConsumer<<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,java.lang.Throwable> onError)</pre> |
| <div class="block">Register a listener, which will be called when an exception was thrown by a given SSE event output when trying to |
| write to it or close it. |
| <p> |
| This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. The |
| <code>SseBroadcaster</code> implementation is optimized to efficiently handle small amounts of concurrent listener |
| registrations and removals and large amounts of registered listener notifications.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>onError</code> - bi-consumer, taking two parameters: <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which is the source of the error and the |
| actual <code>Throwable</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onClose-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onClose</h4> |
| <pre>void onClose(java.util.function.Consumer<<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>> onClose)</pre> |
| <div class="block">Register a listener, which will be called when the SSE event output has been closed (either by client closing the |
| connection or by calling <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html#close--"><code>SseEventSink.close()</code></a> on the server side. |
| <p> |
| This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. The |
| <code>SseBroadcaster</code> implementation is optimized to efficiently handle small amounts of concurrent listener |
| registrations and removals and large amounts of registered listener notifications.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>onClose</code> - consumer taking single parameter, a <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which was closed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-jakarta.ws.rs.sse.SseEventSink-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>void register(<a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a> sseEventSink)</pre> |
| <div class="block">Register provided <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instance to this <code>SseBroadcaster</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sseEventSink</code> - to be registered.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="broadcast-jakarta.ws.rs.sse.OutboundSseEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>broadcast</h4> |
| <pre>java.util.concurrent.CompletionStage<?> broadcast(<a href="../../../../jakarta/ws/rs/sse/OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a> event)</pre> |
| <div class="block">Publish an SSE event to all registered <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - SSE event to be published.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>completion stage that completes when the event has been broadcast to all registered event sinks.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Close the broadcaster and all registered <a href="../../../../jakarta/ws/rs/sse/SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances. |
| <p> |
| Any other resources associated with the <a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html" title="interface in jakarta.ws.rs.sse"><code>SseBroadcaster</code></a> should be released. |
| <p> |
| Subsequent calls have no effect and are ignored. Once the <a href="../../../../jakarta/ws/rs/sse/SseBroadcaster.html" title="interface in jakarta.ws.rs.sse"><code>SseBroadcaster</code></a> is closed, |
| invoking any other method on the broadcaster instance would result in an <code>IllegalStateException</code> |
| being thrown.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></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="../../../../jakarta/ws/rs/sse/Sse.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/sse/SseEvent.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/sse/SseBroadcaster.html" target="_top">Frames</a></li> |
| <li><a href="SseBroadcaster.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> |
| </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 ======= --> |
| </body> |
| </html> |