| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/Drop.html |
<!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 -->
<title>Drop</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="Drop";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Drop.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">
<li><a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/Drop.Kind.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/Drop.html" target="_top">Frames</a></li>
<li><a href="Drop.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><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.opensolaris.os.dtrace</div>
<h2 title="Class Drop" class="title">Class Drop</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.Drop</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Drop</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">Detail about one or more records dropped by DTrace (not reported to
<a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#dataReceived-org.opensolaris.os.dtrace.DataEvent-"><code>ConsumerListener.dataReceived()</code></a>) due to inadequte buffer space.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/ConsumerListener.html#dataDropped-org.opensolaris.os.dtrace.DropEvent-"><code>ConsumerListener.dataDropped(DropEvent e)</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.Drop">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.Kind.html" title="enum in org.opensolaris.os.dtrace">Drop.Kind</a></span></code>
<div class="block">Indicates what kind of buffer space experienced the data drop
(such as principal buffer or aggregation buffer) and possibly a
reason.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#Drop-int-java.lang.String-long-long-java.lang.String-">Drop</a></span>(int dropCPU,
java.lang.String dropKindName,
long dropCount,
long totalDrops,
java.lang.String defaultDropMessage)</code>
<div class="block">Creates a <code>Drop</code> instance with the given CPU, drop kind,
drop counts, and default message.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#getCount--">getCount</a></span>()</code>
<div class="block">Gets the number of drops reported by this <code>Drop</code> instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#getCPU--">getCPU</a></span>()</code>
<div class="block">Gets the CPU where the drops occurred.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#getDefaultMessage--">getDefaultMessage</a></span>()</code>
<div class="block">Gets the message provided by DTrace.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/Drop.Kind.html" title="enum in org.opensolaris.os.dtrace">Drop.Kind</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#getKind--">getKind</a></span>()</code>
<div class="block">Gets the kind of drop for all drops included in <a href="../../../../org/opensolaris/os/dtrace/Drop.html#getCount--"><code>getCount()</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#getTotal--">getTotal</a></span>()</code>
<div class="block">Gets the total number of drops since the source <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>
started running.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/Drop.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this drop instance, not intended
for display.</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 java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="Drop-int-java.lang.String-long-long-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Drop</h4>
<pre>public Drop(int dropCPU,
java.lang.String dropKindName,
long dropCount,
long totalDrops,
java.lang.String defaultDropMessage)</pre>
<div class="block">Creates a <code>Drop</code> instance with the given CPU, drop kind,
drop counts, and default message. Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dropCPU</code> - cpu where drops occurred</dd>
<dd><code>dropKindName</code> - name of enumeration value indicating the kind
of buffer space where the drop occurred and possibly a reason</dd>
<dd><code>dropCount</code> - number of drops</dd>
<dd><code>totalDrops</code> - total number of drops since the source <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a> started running</dd>
<dd><code>defaultDropMessage</code> - drop message provided by DTrace</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there is no <code>Drop.Kind</code>
value with the given name or if <code>dropCount</code> or <code>totalDrops</code> is negative</dd>
<dd><code>java.lang.NullPointerException</code> - if the given <code>Drop.Kind</code> name
or default message is <code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCPU--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCPU</h4>
<pre>public int getCPU()</pre>
<div class="block">Gets the CPU where the drops occurred.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative CPU ID, or a negative number if the CPU is
unknown</dd>
</dl>
</li>
</ul>
<a name="getKind--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKind</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/Drop.Kind.html" title="enum in org.opensolaris.os.dtrace">Drop.Kind</a> getKind()</pre>
<div class="block">Gets the kind of drop for all drops included in <a href="../../../../org/opensolaris/os/dtrace/Drop.html#getCount--"><code>getCount()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null drop kind</dd>
</dl>
</li>
</ul>
<a name="getCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCount</h4>
<pre>public long getCount()</pre>
<div class="block">Gets the number of drops reported by this <code>Drop</code> instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative drop count</dd>
</dl>
</li>
</ul>
<a name="getTotal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotal</h4>
<pre>public long getTotal()</pre>
<div class="block">Gets the total number of drops since the source <a href="../../../../org/opensolaris/os/dtrace/Consumer.html" title="interface in org.opensolaris.os.dtrace"><code>Consumer</code></a>
started running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative drop total since tracing started</dd>
</dl>
</li>
</ul>
<a name="getDefaultMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMessage</h4>
<pre>public java.lang.String getDefaultMessage()</pre>
<div class="block">Gets the message provided by DTrace.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null message provided by DTrace</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Gets a string representation of this drop instance, not intended
for display. The exact details of the representation are
unspecified and subject to change, but the following format may
be regarded as typical:
<pre><code>
class-name[property1 = value1, property2 = value2]
</code></pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Drop.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">
<li><a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/Drop.Kind.html" title="enum in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/Drop.html" target="_top">Frames</a></li>
<li><a href="Drop.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><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>