src/components/artemis/documentation/javadocs/javadoc-latest/org/apache/activemq/artemis/api/core/BroadcastEndpoint.html - activemq-website - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>BroadcastEndpoint (ActiveMQ Artemis Website 2.33.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <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="BroadcastEndpoint (ActiveMQ Artemis Website 2.33.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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>
 <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/BroadcastEndpoint.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="../../../../../../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>
 <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">org.apache.activemq.artemis.api.core</a></div>
 <h2 title="Interface BroadcastEndpoint" class="title">Interface BroadcastEndpoint</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="JGroupsBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsBroadcastEndpoint</a></code>, <code><a href="JGroupsChannelBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsChannelBroadcastEndpoint</a></code>, <code><a href="JGroupsFileBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsFileBroadcastEndpoint</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">BroadcastEndpoint</span></pre>
 <div class="block">BroadcastEndpint is used in BroadcastGroups and DiscoveryGroups for topology updates.
  <p>
  A BroadcastEndpoint can perform one of the two following tasks:
  <ul>
  <li>when being used in BroadcastGroups, it broadcasts connector informations</li>
  <li>when being used in DiscoveryGroups, it receives broadcasts</li>
  </ul>
  <p>
  The two tasks are mutual exclusive, meaning a BroadcastEndpoint can either be a broadcaster
  or a receiver, but not both.
  <p>
  It is an abstraction of various concrete broadcasting mechanisms. Different implementations
  of this interface may use different broadcasting techniques like UDP multicasting or
  JGroups channels.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="JGroupsBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core"><code>JGroupsBroadcastEndpoint</code></a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <section>
 <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>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#broadcast(byte%5B%5D)">broadcast</a></span>&#8203;(byte[]&nbsp;data)</code></th>
 <td class="colLast">
 <div class="block">Broadcasting data to the cluster.</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(boolean)">close</a></span>&#8203;(boolean&nbsp;isBroadcast)</code></th>
 <td class="colLast">
 <div class="block">Close the endpoint.</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="#openBroadcaster()">openBroadcaster</a></span>()</code></th>
 <td class="colLast">
 <div class="block">This method initializes a BroadcastEndpint as
  a broadcaster.</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="#openClient()">openClient</a></span>()</code></th>
 <td class="colLast">
 <div class="block">This method initializes a BroadcastEndpoint as
  a receiving end for broadcasts.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>byte[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBroadcast()">receiveBroadcast</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Receives the broadcast data.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>byte[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBroadcast(long,java.util.concurrent.TimeUnit)">receiveBroadcast</a></span>&#8203;(long&nbsp;time,
                 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</code></th>
 <td class="colLast">
 <div class="block">Receives the broadcast data with a timeout.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="openClient()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>openClient</h4>
 <pre class="methodSignature">void&nbsp;openClient()
          throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">This method initializes a BroadcastEndpoint as
  a receiving end for broadcasts. After that data can be
  received using one of its receiveBroadcast() methods.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="openBroadcaster()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>openBroadcaster</h4>
 <pre class="methodSignature">void&nbsp;openBroadcaster()
               throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">This method initializes a BroadcastEndpint as
  a broadcaster. After that data can be sent
  via its broadcast() method.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="close(boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre class="methodSignature">void&nbsp;close&#8203;(boolean&nbsp;isBroadcast)
     throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">Close the endpoint. Any related resources should
  be cleaned up in this method.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>isBroadcast</code> - : indicates whether this endpoint serves as a broadcast or not.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="broadcast(byte[])">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>broadcast</h4>
 <pre class="methodSignature">void&nbsp;broadcast&#8203;(byte[]&nbsp;data)
         throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">Broadcasting data to the cluster.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>data</code> - : a byte array containing the data.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="receiveBroadcast()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>receiveBroadcast</h4>
 <pre class="methodSignature">byte[]&nbsp;receiveBroadcast()
                  throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">Receives the broadcast data. It blocks until data is
  available.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the received data as byte array.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="receiveBroadcast(long,java.util.concurrent.TimeUnit)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>receiveBroadcast</h4>
 <pre class="methodSignature">byte[]&nbsp;receiveBroadcast&#8203;(long&nbsp;time,
                         <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)
                  throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
 <div class="block">Receives the broadcast data with a timeout. It blocks until either
  the data is available or the timeout is reached, whichever comes first.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>time</code> - : how long the method should wait for the data to arrive.</dd>
 <dd><code>unit</code> - : unit of the time.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a byte array if data is arrived within the timeout, or null if no data
  is available after the timeout.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</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/BroadcastEndpoint.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="../../../../../../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>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>BroadcastEndpoint (ActiveMQ Artemis Website 2.33.0 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<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="BroadcastEndpoint (ActiveMQ Artemis Website 2.33.0 API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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>
	<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/BroadcastEndpoint.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="../../../../../../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>
	<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">org.apache.activemq.artemis.api.core</a></div>
	<h2 title="Interface BroadcastEndpoint" class="title">Interface BroadcastEndpoint</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="JGroupsBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsBroadcastEndpoint</a></code>, <code><a href="JGroupsChannelBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsChannelBroadcastEndpoint</a></code>, <code><a href="JGroupsFileBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core">JGroupsFileBroadcastEndpoint</a></code></dd>
	</dl>
	<hr>
	<pre>public interface <span class="typeNameLabel">BroadcastEndpoint</span></pre>
	<div class="block">BroadcastEndpint is used in BroadcastGroups and DiscoveryGroups for topology updates.
	<p>
	A BroadcastEndpoint can perform one of the two following tasks:
	<ul>
	<li>when being used in BroadcastGroups, it broadcasts connector informations</li>
	<li>when being used in DiscoveryGroups, it receives broadcasts</li>
	</ul>
	<p>
	The two tasks are mutual exclusive, meaning a BroadcastEndpoint can either be a broadcaster
	or a receiver, but not both.
	<p>
	It is an abstraction of various concrete broadcasting mechanisms. Different implementations
	of this interface may use different broadcasting techniques like UDP multicasting or
	JGroups channels.</div>
	<dl>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="JGroupsBroadcastEndpoint.html" title="class in org.apache.activemq.artemis.api.core"><code>JGroupsBroadcastEndpoint</code></a></dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========== METHOD SUMMARY =========== -->
	<section>
	<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>void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#broadcast(byte%5B%5D)">broadcast</a></span>(byte[] data)</code></th>
	<td class="colLast">
	<div class="block">Broadcasting data to the cluster.</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(boolean)">close</a></span>(boolean isBroadcast)</code></th>
	<td class="colLast">
	<div class="block">Close the endpoint.</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="#openBroadcaster()">openBroadcaster</a></span>()</code></th>
	<td class="colLast">
	<div class="block">This method initializes a BroadcastEndpint as
	a broadcaster.</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="#openClient()">openClient</a></span>()</code></th>
	<td class="colLast">
	<div class="block">This method initializes a BroadcastEndpoint as
	a receiving end for broadcasts.</div>
	</td>
	</tr>
	<tr id="i4" class="altColor">
	<td class="colFirst"><code>byte[]</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBroadcast()">receiveBroadcast</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Receives the broadcast data.</div>
	</td>
	</tr>
	<tr id="i5" class="rowColor">
	<td class="colFirst"><code>byte[]</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveBroadcast(long,java.util.concurrent.TimeUnit)">receiveBroadcast</a></span>(long time,
	<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> unit)</code></th>
	<td class="colLast">
	<div class="block">Receives the broadcast data with a timeout.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<section>
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="openClient()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>openClient</h4>
	<pre class="methodSignature">void openClient()
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">This method initializes a BroadcastEndpoint as
	a receiving end for broadcasts. After that data can be
	received using one of its receiveBroadcast() methods.</div>
	<dl>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
	</dl>
	</li>
	</ul>
	<a id="openBroadcaster()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>openBroadcaster</h4>
	<pre class="methodSignature">void openBroadcaster()
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">This method initializes a BroadcastEndpint as
	a broadcaster. After that data can be sent
	via its broadcast() method.</div>
	<dl>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
	</dl>
	</li>
	</ul>
	<a id="close(boolean)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>close</h4>
	<pre class="methodSignature">void close(boolean isBroadcast)
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">Close the endpoint. Any related resources should
	be cleaned up in this method.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>isBroadcast</code> - : indicates whether this endpoint serves as a broadcast or not.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
	</dl>
	</li>
	</ul>
	<a id="broadcast(byte[])">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>broadcast</h4>
	<pre class="methodSignature">void broadcast(byte[] data)
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">Broadcasting data to the cluster.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>data</code> - : a byte array containing the data.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
	</dl>
	</li>
	</ul>
	<a id="receiveBroadcast()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>receiveBroadcast</h4>
	<pre class="methodSignature">byte[] receiveBroadcast()
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">Receives the broadcast data. It blocks until data is
	available.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the received data as byte array.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
	</dl>
	</li>
	</ul>
	<a id="receiveBroadcast(long,java.util.concurrent.TimeUnit)">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>receiveBroadcast</h4>
	<pre class="methodSignature">byte[] receiveBroadcast(long time,
	<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> unit)
	throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
	<div class="block">Receives the broadcast data with a timeout. It blocks until either
	the data is available or the timeout is reached, whichever comes first.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>time</code> - : how long the method should wait for the data to arrive.</dd>
	<dd><code>unit</code> - : unit of the time.</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>a byte array if data is arrived within the timeout, or null if no data
	is available after the timeout.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</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/BroadcastEndpoint.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="../../../../../../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>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>