summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/broadcast/TorrentBroadcastFactory.html
blob: 5bce1de9572b0d1dba28f96184dee7b9d8cc24bf (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                                      
                                       














































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                             
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Sep 16 10:26:35 PDT 2015 -->
<title>TorrentBroadcastFactory</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="TorrentBroadcastFactory";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../org/apache/spark/broadcast/HttpBroadcastFactory.html" title="class in org.apache.spark.broadcast"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/broadcast/TorrentBroadcastFactory.html" target="_top">Frames</a></li>
<li><a href="TorrentBroadcastFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.spark.broadcast</div>
<h2 title="Class TorrentBroadcastFactory" class="title">Class TorrentBroadcastFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.broadcast.TorrentBroadcastFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">TorrentBroadcastFactory</span>
extends java.lang.Object
implements <a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></pre>
<div class="block">A <a href="../../../../org/apache/spark/broadcast/Broadcast.html" title="class in org.apache.spark.broadcast"><code>Broadcast</code></a> implementation that uses a BitTorrent-like
 protocol to do a distributed transfer of the broadcasted data to the executors. Refer to
 <code>TorrentBroadcast</code> for more details.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/spark/broadcast/TorrentBroadcastFactory.html#TorrentBroadcastFactory()">TorrentBroadcastFactory</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/broadcast/TorrentBroadcastFactory.html#initialize(boolean, org.apache.spark.SparkConf, org.apache.spark.SecurityManager)">initialize</a></strong>(boolean&nbsp;isDriver,
          <a href="../../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a>&nbsp;conf,
          org.apache.spark.SecurityManager&nbsp;securityMgr)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../org/apache/spark/broadcast/Broadcast.html" title="class in org.apache.spark.broadcast">Broadcast</a>&lt;T&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/broadcast/TorrentBroadcastFactory.html#newBroadcast(T, boolean, long, scala.reflect.ClassTag)">newBroadcast</a></strong>(T&nbsp;value_,
            boolean&nbsp;isLocal,
            long&nbsp;id,
            scala.reflect.ClassTag&lt;T&gt;&nbsp;evidence$1)</code>
<div class="block">Creates a new broadcast variable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/broadcast/TorrentBroadcastFactory.html#stop()">stop</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/broadcast/TorrentBroadcastFactory.html#unbroadcast(long, boolean, boolean)">unbroadcast</a></strong>(long&nbsp;id,
           boolean&nbsp;removeFromDriver,
           boolean&nbsp;blocking)</code>
<div class="block">Remove all persisted state associated with the torrent broadcast with the given ID.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TorrentBroadcastFactory()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TorrentBroadcastFactory</h4>
<pre>public&nbsp;TorrentBroadcastFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="initialize(boolean, org.apache.spark.SparkConf, org.apache.spark.SecurityManager)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(boolean&nbsp;isDriver,
              <a href="../../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a>&nbsp;conf,
              org.apache.spark.SecurityManager&nbsp;securityMgr)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html#initialize(boolean, org.apache.spark.SparkConf, org.apache.spark.SecurityManager)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="newBroadcast(java.lang.Object,boolean,long,scala.reflect.ClassTag)">
<!--   -->
</a><a name="newBroadcast(T, boolean, long, scala.reflect.ClassTag)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroadcast</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="../../../../org/apache/spark/broadcast/Broadcast.html" title="class in org.apache.spark.broadcast">Broadcast</a>&lt;T&gt;&nbsp;newBroadcast(T&nbsp;value_,
                            boolean&nbsp;isLocal,
                            long&nbsp;id,
                            scala.reflect.ClassTag&lt;T&gt;&nbsp;evidence$1)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html#newBroadcast(T, boolean, long, scala.reflect.ClassTag)">BroadcastFactory</a></code></strong></div>
<div class="block">Creates a new broadcast variable.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html#newBroadcast(T, boolean, long, scala.reflect.ClassTag)">newBroadcast</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value_</code> - value to broadcast</dd><dd><code>isLocal</code> - whether we are in local mode (single JVM process)</dd><dd><code>id</code> - unique id representing this broadcast variable</dd><dd><code>evidence$1</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="stop()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;stop()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html#stop()">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="unbroadcast(long, boolean, boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unbroadcast</h4>
<pre>public&nbsp;void&nbsp;unbroadcast(long&nbsp;id,
               boolean&nbsp;removeFromDriver,
               boolean&nbsp;blocking)</pre>
<div class="block">Remove all persisted state associated with the torrent broadcast with the given ID.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html#unbroadcast(long, boolean, boolean)">unbroadcast</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/spark/broadcast/BroadcastFactory.html" title="interface in org.apache.spark.broadcast">BroadcastFactory</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>removeFromDriver</code> - Whether to remove state from the driver.</dd><dd><code>blocking</code> - Whether to block until unbroadcasted</dd><dd><code>id</code> - (undocumented)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../org/apache/spark/broadcast/HttpBroadcastFactory.html" title="class in org.apache.spark.broadcast"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/broadcast/TorrentBroadcastFactory.html" target="_top">Frames</a></li>
<li><a href="TorrentBroadcastFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../lib/api-javadocs.js"></script></body>
</html>