apidocs/3.0.0/jakarta/ws/rs/sse/SseBroadcaster.html - third_party/jakartaee/rest - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
 <title>SseBroadcaster (jakarta.ws.rs-api 3.0.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-09-23">
 <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-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.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="SseBroadcaster (jakarta.ws.rs-api 3.0.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"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";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/SseBroadcaster.html">Use</a></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" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.ws.rs.sse</a></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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">SseBroadcaster</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></pre>
 <div class="block">Server-Sent events broadcasting facility.
  <p>
  Server broadcaster can be used to manage multiple <a href="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>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Marek Potociar</dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">CompletionStage</a>&lt;?&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#broadcast(jakarta.ws.rs.sse.OutboundSseEvent)">broadcast</a></span>&#8203;(<a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a>&nbsp;event)</code></th>
 <td class="colLast">
 <div class="block">Publish an SSE event to all registered <a href="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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Close the broadcaster and all registered <a href="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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose(java.util.function.Consumer)">onClose</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a>&lt;<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>&gt;&nbsp;onClose)</code></th>
 <td class="colLast">
 <div class="block">Register a listener, which will be called when this SseBroadcaster closes a given event <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> or
  tries to write to a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> that is already closed (either by client closing the connection
  or by calling <a href="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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError(java.util.function.BiConsumer)">onError</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;onError)</code></th>
 <td class="colLast">
 <div class="block">Register a listener, which will be called when an exception is thrown by a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>
  when this SseBroadcaster tries to write to it or close it.</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="#register(jakarta.ws.rs.sse.SseEventSink)">register</a></span>&#8203;(<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>&nbsp;sseEventSink)</code></th>
 <td class="colLast">
 <div class="block">Register provided <a href="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>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="onError(java.util.function.BiConsumer)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>onError</h4>
 <pre class="methodSignature">void&nbsp;onError&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a>&lt;<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;onError)</pre>
 <div class="block">Register a listener, which will be called when an exception is thrown by a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>
  when this SseBroadcaster tries 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="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which is the source of the error and the
  actual <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Throwable</code></a> instance.</dd>
 </dl>
 </li>
 </ul>
 <a id="onClose(java.util.function.Consumer)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>onClose</h4>
 <pre class="methodSignature">void&nbsp;onClose&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a>&lt;<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>&gt;&nbsp;onClose)</pre>
 <div class="block">Register a listener, which will be called when this SseBroadcaster closes a given event <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> or
  tries to write to a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> that is already closed (either by client closing the connection
  or by calling <a href="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="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which was closed.</dd>
 </dl>
 </li>
 </ul>
 <a id="register(jakarta.ws.rs.sse.SseEventSink)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>register</h4>
 <pre class="methodSignature">void&nbsp;register&#8203;(<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>&nbsp;sseEventSink)</pre>
 <div class="block">Register provided <a href="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 id="broadcast(jakarta.ws.rs.sse.OutboundSseEvent)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>broadcast</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">CompletionStage</a>&lt;?&gt;&nbsp;broadcast&#8203;(<a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a>&nbsp;event)</pre>
 <div class="block">Publish an SSE event to all registered <a href="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 id="close()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>close</h4>
 <pre class="methodSignature">void&nbsp;close()</pre>
 <div class="block">Close the broadcaster and all registered <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances.
  <p>
  Any other resources associated with the <a href="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="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 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a>
  being thrown.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/SseBroadcaster.html">Use</a></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" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
	<title>SseBroadcaster (jakarta.ws.rs-api 3.0.0 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="dc.created" content="2020-09-23">
	<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-3.3.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.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="SseBroadcaster (jakarta.ws.rs-api 3.0.0 API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"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";
	var pathtoroot = "../../../../";
	var useModuleDirectories = true;
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<header role="banner">
	<nav role="navigation">
	<div class="fixedNav">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/SseBroadcaster.html">Use</a></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" id="allclasses_navbar_top">
	<li><a href="../../../../allclasses.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 id="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>
	</nav>
	</header>
	<!-- ======== START OF CLASS DATA ======== -->
	<main role="main">
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.ws.rs.sse</a></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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
	</dl>
	<hr>
	<pre>public interface <span class="typeNameLabel">SseBroadcaster</span>
	extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></pre>
	<div class="block">Server-Sent events broadcasting facility.
	<p>
	Server broadcaster can be used to manage multiple <a href="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>
	<dt><span class="simpleTagLabel">Author:</span></dt>
	<dd>Marek Potociar</dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========== METHOD SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary">
	<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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">CompletionStage</a><?></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#broadcast(jakarta.ws.rs.sse.OutboundSseEvent)">broadcast</a></span>(<a href="OutboundSseEvent.html" title="interface in jakarta.ws.rs.sse">OutboundSseEvent</a> event)</code></th>
	<td class="colLast">
	<div class="block">Publish an SSE event to all registered <a href="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>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Close the broadcaster and all registered <a href="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>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose(java.util.function.Consumer)">onClose</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>> onClose)</code></th>
	<td class="colLast">
	<div class="block">Register a listener, which will be called when this SseBroadcaster closes a given event <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> or
	tries to write to a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> that is already closed (either by client closing the connection
	or by calling <a href="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>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError(java.util.function.BiConsumer)">onError</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>> onError)</code></th>
	<td class="colLast">
	<div class="block">Register a listener, which will be called when an exception is thrown by a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>
	when this SseBroadcaster tries to write to it or close it.</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="#register(jakarta.ws.rs.sse.SseEventSink)">register</a></span>(<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a> sseEventSink)</code></th>
	<td class="colLast">
	<div class="block">Register provided <a href="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>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="onError(java.util.function.BiConsumer)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>onError</h4>
	<pre class="methodSignature">void onError(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>> onError)</pre>
	<div class="block">Register a listener, which will be called when an exception is thrown by a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>
	when this SseBroadcaster tries 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="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which is the source of the error and the
	actual <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Throwable</code></a> instance.</dd>
	</dl>
	</li>
	</ul>
	<a id="onClose(java.util.function.Consumer)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>onClose</h4>
	<pre class="methodSignature">void onClose(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a>> onClose)</pre>
	<div class="block">Register a listener, which will be called when this SseBroadcaster closes a given event <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> or
	tries to write to a given <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> that is already closed (either by client closing the connection
	or by calling <a href="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="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a>, which was closed.</dd>
	</dl>
	</li>
	</ul>
	<a id="register(jakarta.ws.rs.sse.SseEventSink)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>register</h4>
	<pre class="methodSignature">void register(<a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse">SseEventSink</a> sseEventSink)</pre>
	<div class="block">Register provided <a href="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 id="broadcast(jakarta.ws.rs.sse.OutboundSseEvent)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>broadcast</h4>
	<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">CompletionStage</a><?> broadcast(<a href="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="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 id="close()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>close</h4>
	<pre class="methodSignature">void close()</pre>
	<div class="block">Close the broadcaster and all registered <a href="SseEventSink.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSink</code></a> instances.
	<p>
	Any other resources associated with the <a href="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="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 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a>
	being thrown.</div>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	</div>
	</main>
	<!-- ========= END OF CLASS DATA ========= -->
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/SseBroadcaster.html">Use</a></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" id="allclasses_navbar_bottom">
	<li><a href="../../../../allclasses.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 id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small><p align="left">Copyright © 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
	</footer>
	</body>
	</html>