PageRenderTime 43ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 0ms

/jdk-7u76-docs-all/docs/api/java/nio/channels/Channel.html

https://gitlab.com/PNNutkung/Java-API
HTML | 283 lines | 237 code | 6 blank | 40 comment | 0 complexity | 6eeb27b5ef31c0a7c3d7a89c8ab286a4 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (version 1.6.0_18) on Thu Dec 18 17:17:14 PST 2014 -->
    6. 

  6. <title>Channel (Java Platform SE 7 )</title>
    7. 

  7. <meta name="date" content="2014-12-18">
    8. 

  8. <meta name="keywords" content="java.nio.channels.Channel interface">
    9. 

  9. <meta name="keywords" content="isOpen()">
    10. 

  10. <meta name="keywords" content="close()">
    11. 

  11. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <script type="text/javascript"><!--
    15. 

  15.     if (location.href.indexOf('is-external=true') == -1) {
    16. 

  16.         parent.document.title="Channel (Java Platform SE 7 )";
    17. 

  17.     }
    18. 

  18. //-->
    19. 

  19. </script>
    20. 

  20. <noscript>
    21. 

  21. <div>JavaScript is disabled on your browser.</div>
    22. 

  22. </noscript>
    23. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <div class="topNav"><a name="navbar_top">
    25. 

  25. <!--   -->
    26. 

  26. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    27. 

  27. <!--   -->
    28. 

  28. </a>
    29. 

  29. <ul class="navList" title="Navigation">
    30. 

  30. <li><a href="../../../overview-summary.html">Overview</a></li>
    31. 

  31. <li><a href="package-summary.html">Package</a></li>
    32. 

  32. <li class="navBarCell1Rev">Class</li>
    33. 

  33. <li><a href="class-use/Channel.html">Use</a></li>
    34. 

  34. <li><a href="package-tree.html">Tree</a></li>
    35. 

  35. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    36. 

  36. <li><a href="../../../index-files/index-1.html">Index</a></li>
    37. 

  37. <li><a href="../../../help-doc.html">Help</a></li>
    38. 

  38. </ul>
    39. 

  39. <div class="aboutLanguage"><em><strong>Java&trade;&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;7</strong></em></div>
    40. 

  40. </div>
    41. 

  41. <div class="subNav">
    42. 

  42. <ul class="navList">
    43. 

  43. <li><a href="../../../java/nio/channels/CancelledKeyException.html" title="class in java.nio.channels"><span class="strong">Prev Class</span></a></li>
    44. 

  44. <li><a href="../../../java/nio/channels/Channels.html" title="class in java.nio.channels"><span class="strong">Next Class</span></a></li>
    45. 

  45. </ul>
    46. 

  46. <ul class="navList">
    47. 

  47. <li><a href="../../../index.html?java/nio/channels/Channel.html" target="_top">Frames</a></li>
    48. 

  48. <li><a href="Channel.html" target="_top">No Frames</a></li>
    49. 

  49. </ul>
    50. 

  50. <ul class="navList" id="allclasses_navbar_top">
    51. 

  51. <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
    52. 

  52. </ul>
    53. 

  53. <div>
    54. 

  54. <script type="text/javascript"><!--
    55. 

  55.   allClassesLink = document.getElementById("allclasses_navbar_top");
    56. 

  56.   if(window==top) {
    57. 

  57.     allClassesLink.style.display = "block";
    58. 

  58.   }
    59. 

  59.   else {
    60. 

  60.     allClassesLink.style.display = "none";
    61. 

  61.   }
    62. 

  62.   //-->
    63. 

  63. </script>
    64. 

  64. </div>
    65. 

  65. <div>
    66. 

  66. <ul class="subNavList">
    67. 

  67. <li>Summary:&nbsp;</li>
    68. 

  68. <li>Nested&nbsp;|&nbsp;</li>
    69. 

  69. <li>Field&nbsp;|&nbsp;</li>
    70. 

  70. <li>Constr&nbsp;|&nbsp;</li>
    71. 

  71. <li><a href="#method_summary">Method</a></li>
    72. 

  72. </ul>
    73. 

  73. <ul class="subNavList">
    74. 

  74. <li>Detail:&nbsp;</li>
    75. 

  75. <li>Field&nbsp;|&nbsp;</li>
    76. 

  76. <li>Constr&nbsp;|&nbsp;</li>
    77. 

  77. <li><a href="#method_detail">Method</a></li>
    78. 

  78. </ul>
    79. 

  79. </div>
    80. 

  80. <a name="skip-navbar_top">
    81. 

  81. <!--   -->
    82. 

  82. </a></div>
    83. 

  83. <!-- ========= END OF TOP NAVBAR ========= -->
    84. 

  84. <!-- ======== START OF CLASS DATA ======== -->
    85. 

  85. <div class="header">
    86. 

  86. <div class="subTitle">java.nio.channels</div>
    87. 

  87. <h2 title="Interface Channel" class="title">Interface Channel</h2>
    88. 

  88. </div>
    89. 

  89. <div class="contentContainer">
    90. 

  90. <div class="description">
    91. 

  91. <ul class="blockList">
    92. 

  92. <li class="blockList">
    93. 

  93. <dl>
    94. 

  94. <dt>All Superinterfaces:</dt>
    95. 

  95. <dd><a href="../../../java/lang/AutoCloseable.html" title="interface in java.lang">AutoCloseable</a>, <a href="../../../java/io/Closeable.html" title="interface in java.io">Closeable</a></dd>
    96. 

  96. </dl>
    97. 

  97. <dl>
    98. 

  98. <dt>All Known Subinterfaces:</dt>
    99. 

  99. <dd><a href="../../../java/nio/channels/AsynchronousByteChannel.html" title="interface in java.nio.channels">AsynchronousByteChannel</a>, <a href="../../../java/nio/channels/AsynchronousChannel.html" title="interface in java.nio.channels">AsynchronousChannel</a>, <a href="../../../java/nio/channels/ByteChannel.html" title="interface in java.nio.channels">ByteChannel</a>, <a href="../../../java/nio/channels/GatheringByteChannel.html" title="interface in java.nio.channels">GatheringByteChannel</a>, <a href="../../../java/nio/channels/InterruptibleChannel.html" title="interface in java.nio.channels">InterruptibleChannel</a>, <a href="../../../java/nio/channels/MulticastChannel.html" title="interface in java.nio.channels">MulticastChannel</a>, <a href="../../../java/nio/channels/NetworkChannel.html" title="interface in java.nio.channels">NetworkChannel</a>, <a href="../../../java/nio/channels/ReadableByteChannel.html" title="interface in java.nio.channels">ReadableByteChannel</a>, <a href="../../../java/nio/channels/ScatteringByteChannel.html" title="interface in java.nio.channels">ScatteringByteChannel</a>, <a href="../../../java/nio/channels/SeekableByteChannel.html" title="interface in java.nio.channels">SeekableByteChannel</a>, <a href="../../../java/nio/channels/WritableByteChannel.html" title="interface in java.nio.channels">WritableByteChannel</a></dd>
    100. 

  100. </dl>
    101. 

  101. <dl>
    102. 

  102. <dt>All Known Implementing Classes:</dt>
    103. 

  103. <dd><a href="../../../java/nio/channels/spi/AbstractInterruptibleChannel.html" title="class in java.nio.channels.spi">AbstractInterruptibleChannel</a>, <a href="../../../java/nio/channels/spi/AbstractSelectableChannel.html" title="class in java.nio.channels.spi">AbstractSelectableChannel</a>, <a href="../../../java/nio/channels/AsynchronousFileChannel.html" title="class in java.nio.channels">AsynchronousFileChannel</a>, <a href="../../../java/nio/channels/AsynchronousServerSocketChannel.html" title="class in java.nio.channels">AsynchronousServerSocketChannel</a>, <a href="../../../java/nio/channels/AsynchronousSocketChannel.html" title="class in java.nio.channels">AsynchronousSocketChannel</a>, <a href="../../../java/nio/channels/DatagramChannel.html" title="class in java.nio.channels">DatagramChannel</a>, <a href="../../../java/nio/channels/FileChannel.html" title="class in java.nio.channels">FileChannel</a>, <a href="../../../java/nio/channels/Pipe.SinkChannel.html" title="class in java.nio.channels">Pipe.SinkChannel</a>, <a href="../../../java/nio/channels/Pipe.SourceChannel.html" title="class in java.nio.channels">Pipe.SourceChannel</a>, <a href="../../../java/nio/channels/SelectableChannel.html" title="class in java.nio.channels">SelectableChannel</a>, <a href="../../../java/nio/channels/ServerSocketChannel.html" title="class in java.nio.channels">ServerSocketChannel</a>, <a href="../../../java/nio/channels/SocketChannel.html" title="class in java.nio.channels">SocketChannel</a></dd>
    104. 

  104. </dl>
    105. 

  105. <hr>
    106. 

  106. <br>
    107. 

  107. <pre>public interface <span class="strong">Channel</span>
    108. 

  108. extends <a href="../../../java/io/Closeable.html" title="interface in java.io">Closeable</a></pre>
    109. 

  109. <div class="block">A nexus for I/O operations.
    110. 

  110. 

  111.  <p> A channel represents an open connection to an entity such as a hardware
    112. 

  112.  device, a file, a network socket, or a program component that is capable of
    113. 

  113.  performing one or more distinct I/O operations, for example reading or
    114. 

  114.  writing.
    115. 

  115. 

  116.  <p> A channel is either open or closed.  A channel is open upon creation,
    117. 

  117.  and once closed it remains closed.  Once a channel is closed, any attempt to
    118. 

  118.  invoke an I/O operation upon it will cause a <a href="../../../java/nio/channels/ClosedChannelException.html" title="class in java.nio.channels"><code>ClosedChannelException</code></a>
    119. 

  119.  to be thrown.  Whether or not a channel is open may be tested by invoking
    120. 

  120.  its <a href="../../../java/nio/channels/Channel.html#isOpen()"><code>isOpen</code></a> method.
    121. 

  121. 

  122.  <p> Channels are, in general, intended to be safe for multithreaded access
    123. 

  123.  as described in the specifications of the interfaces and classes that extend
    124. 

  124.  and implement this interface.</div>
    125. 

  125. <dl><dt><span class="strong">Since:</span></dt>
    126. 

  126.   <dd>1.4</dd></dl>
    127. 

  127. </li>
    128. 

  128. </ul>
    129. 

  129. </div>
    130. 

  130. <div class="summary">
    131. 

  131. <ul class="blockList">
    132. 

  132. <li class="blockList">
    133. 

  133. <!-- ========== METHOD SUMMARY =========== -->
    134. 

  134. <ul class="blockList">
    135. 

  135. <li class="blockList"><a name="method_summary">
    136. 

  136. <!--   -->
    137. 

  137. </a>
    138. 

  138. <h3>Method Summary</h3>
    139. 

  139. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    140. 

  140. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    141. 

  141. <tr>
    142. 

  142. <th class="colFirst" scope="col">Modifier and Type</th>
    143. 

  143. <th class="colLast" scope="col">Method and Description</th>
    144. 

  144. </tr>
    145. 

  145. <tr class="altColor">
    146. 

  146. <td class="colFirst"><code>void</code></td>
    147. 

  147. <td class="colLast"><code><strong><a href="../../../java/nio/channels/Channel.html#close()">close</a></strong>()</code>
    148. 

  148. <div class="block">Closes this channel.</div>
    149. 

  149. </td>
    150. 

  150. </tr>
    151. 

  151. <tr class="rowColor">
    152. 

  152. <td class="colFirst"><code>boolean</code></td>
    153. 

  153. <td class="colLast"><code><strong><a href="../../../java/nio/channels/Channel.html#isOpen()">isOpen</a></strong>()</code>
    154. 

  154. <div class="block">Tells whether or not this channel is open.</div>
    155. 

  155. </td>
    156. 

  156. </tr>
    157. 

  157. </table>
    158. 

  158. </li>
    159. 

  159. </ul>
    160. 

  160. </li>
    161. 

  161. </ul>
    162. 

  162. </div>
    163. 

  163. <div class="details">
    164. 

  164. <ul class="blockList">
    165. 

  165. <li class="blockList">
    166. 

  166. <!-- ============ METHOD DETAIL ========== -->
    167. 

  167. <ul class="blockList">
    168. 

  168. <li class="blockList"><a name="method_detail">
    169. 

  169. <!--   -->
    170. 

  170. </a>
    171. 

  171. <h3>Method Detail</h3>
    172. 

  172. <a name="isOpen()">
    173. 

  173. <!--   -->
    174. 

  174. </a>
    175. 

  175. <ul class="blockList">
    176. 

  176. <li class="blockList">
    177. 

  177. <h4>isOpen</h4>
    178. 

  178. <pre>boolean&nbsp;isOpen()</pre>
    179. 

  179. <div class="block">Tells whether or not this channel is open.  </p></div>
    180. 

  180. <dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if, and only if, this channel is open</dd></dl>
    181. 

  181. </li>
    182. 

  182. </ul>
    183. 

  183. <a name="close()">
    184. 

  184. <!--   -->
    185. 

  185. </a>
    186. 

  186. <ul class="blockListLast">
    187. 

  187. <li class="blockList">
    188. 

  188. <h4>close</h4>
    189. 

  189. <pre>void&nbsp;close()
    190. 

  190.            throws <a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
    191. 

  191. <div class="block">Closes this channel.
    192. 

  192. 

  193.  <p> After a channel is closed, any further attempt to invoke I/O
    194. 

  194.  operations upon it will cause a <a href="../../../java/nio/channels/ClosedChannelException.html" title="class in java.nio.channels"><code>ClosedChannelException</code></a> to be
    195. 

  195.  thrown.
    196. 

  196. 

  197.  <p> If this channel is already closed then invoking this method has no
    198. 

  198.  effect.
    199. 

  199. 

  200.  <p> This method may be invoked at any time.  If some other thread has
    201. 

  201.  already invoked it, however, then another invocation will block until
    202. 

  202.  the first invocation is complete, after which it will return without
    203. 

  203.  effect. </p></div>
    204. 

  204. <dl>
    205. 

  205. <dt><strong>Specified by:</strong></dt>
    206. 

  206. <dd><code><a href="../../../java/lang/AutoCloseable.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../java/lang/AutoCloseable.html" title="interface in java.lang">AutoCloseable</a></code></dd>
    207. 

  207. <dt><strong>Specified by:</strong></dt>
    208. 

  208. <dd><code><a href="../../../java/io/Closeable.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../java/io/Closeable.html" title="interface in java.io">Closeable</a></code></dd>
    209. 

  209. <dt><span class="strong">Throws:</span></dt>
    210. 

  210. <dd><code><a href="../../../java/io/IOException.html" title="class in java.io">IOException</a></code> - If an I/O error occurs</dd></dl>
    211. 

  211. </li>
    212. 

  212. </ul>
    213. 

  213. </li>
    214. 

  214. </ul>
    215. 

  215. </li>
    216. 

  216. </ul>
    217. 

  217. </div>
    218. 

  218. </div>
    219. 

  219. <!-- ========= END OF CLASS DATA ========= -->
    220. 

  220. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    221. 

  221. <div class="bottomNav"><a name="navbar_bottom">
    222. 

  222. <!--   -->
    223. 

  223. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    224. 

  224. <!--   -->
    225. 

  225. </a>
    226. 

  226. <ul class="navList" title="Navigation">
    227. 

  227. <li><a href="../../../overview-summary.html">Overview</a></li>
    228. 

  228. <li><a href="package-summary.html">Package</a></li>
    229. 

  229. <li class="navBarCell1Rev">Class</li>
    230. 

  230. <li><a href="class-use/Channel.html">Use</a></li>
    231. 

  231. <li><a href="package-tree.html">Tree</a></li>
    232. 

  232. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    233. 

  233. <li><a href="../../../index-files/index-1.html">Index</a></li>
    234. 

  234. <li><a href="../../../help-doc.html">Help</a></li>
    235. 

  235. </ul>
    236. 

  236. <div class="aboutLanguage"><em><strong>Java&trade;&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;7</strong></em></div>
    237. 

  237. </div>
    238. 

  238. <div class="subNav">
    239. 

  239. <ul class="navList">
    240. 

  240. <li><a href="../../../java/nio/channels/CancelledKeyException.html" title="class in java.nio.channels"><span class="strong">Prev Class</span></a></li>
    241. 

  241. <li><a href="../../../java/nio/channels/Channels.html" title="class in java.nio.channels"><span class="strong">Next Class</span></a></li>
    242. 

  242. </ul>
    243. 

  243. <ul class="navList">
    244. 

  244. <li><a href="../../../index.html?java/nio/channels/Channel.html" target="_top">Frames</a></li>
    245. 

  245. <li><a href="Channel.html" target="_top">No Frames</a></li>
    246. 

  246. </ul>
    247. 

  247. <ul class="navList" id="allclasses_navbar_bottom">
    248. 

  248. <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
    249. 

  249. </ul>
    250. 

  250. <div>
    251. 

  251. <script type="text/javascript"><!--
    252. 

  252.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    253. 

  253.   if(window==top) {
    254. 

  254.     allClassesLink.style.display = "block";
    255. 

  255.   }
    256. 

  256.   else {
    257. 

  257.     allClassesLink.style.display = "none";
    258. 

  258.   }
    259. 

  259.   //-->
    260. 

  260. </script>
    261. 

  261. </div>
    262. 

  262. <div>
    263. 

  263. <ul class="subNavList">
    264. 

  264. <li>Summary:&nbsp;</li>
    265. 

  265. <li>Nested&nbsp;|&nbsp;</li>
    266. 

  266. <li>Field&nbsp;|&nbsp;</li>
    267. 

  267. <li>Constr&nbsp;|&nbsp;</li>
    268. 

  268. <li><a href="#method_summary">Method</a></li>
    269. 

  269. </ul>
    270. 

  270. <ul class="subNavList">
    271. 

  271. <li>Detail:&nbsp;</li>
    272. 

  272. <li>Field&nbsp;|&nbsp;</li>
    273. 

  273. <li>Constr&nbsp;|&nbsp;</li>
    274. 

  274. <li><a href="#method_detail">Method</a></li>
    275. 

  275. </ul>
    276. 

  276. </div>
    277. 

  277. <a name="skip-navbar_bottom">
    278. 

  278. <!--   -->
    279. 

  279. </a></div>
    280. 

  280. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    281. 

  281. <p class="legalCopy"><small><font size="-1"> <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a> <br>For further API reference and developer documentation, see <a href="http://docs.oracle.com/javase/7/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="../../../../legal/cpyr.html">Copyright</a> &#x00a9; 1993, 2015, Oracle and/or its affiliates.  All rights reserved. </font></small></p>
    282. 

  282. </body>
    283. 

  283. </html>
    284. 

  284.