PageRenderTime 66ms CodeModel.GetById 34ms RepoModel.GetById 1ms app.codeStats 0ms

/tools/apache-ant-1.8.4/manual/api/org/apache/tools/ant/taskdefs/condition/Socket.html

https://github.com/vladimirivanov91/jboss-soe
HTML | 336 lines | 285 code | 0 blank | 51 comment | 0 complexity | 817729548a35abe4928cf8d91e550137 MD5 | raw file
Possible License(s): Apache-2.0, GPL-3.0, BSD-3-Clause 
    

  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.7.0_03) on Tue May 22 06:24:53 CEST 2012 -->
    6. 

  6. <title>Socket (Apache Ant API)</title>
    7. 

  7. <meta name="date" content="2012-05-22">
    8. 

  8. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. <script type="text/javascript"><!--
    12. 

  12.     if (location.href.indexOf('is-external=true') == -1) {
    13. 

  13.         parent.document.title="Socket (Apache Ant API)";
    14. 

  14.     }
    15. 

  15. //-->
    16. 

  16. </script>
    17. 

  17. <noscript>
    18. 

  18. <div>JavaScript is disabled on your browser.</div>
    19. 

  19. </noscript>
    20. 

  20. <!-- ========= START OF TOP NAVBAR ======= -->
    21. 

  21. <div class="topNav"><a name="navbar_top">
    22. 

  22. <!--   -->
    23. 

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

  24. <!--   -->
    25. 

  25. </a>
    26. 

  26. <ul class="navList" title="Navigation">
    27. 

  27. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    28. 

  28. <li><a href="package-summary.html">Package</a></li>
    29. 

  29. <li class="navBarCell1Rev">Class</li>
    30. 

  30. <li><a href="package-tree.html">Tree</a></li>
    31. 

  31. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    32. 

  32. <li><a href="../../../../../../index-all.html">Index</a></li>
    33. 

  33. <li><a href="../../../../../../help-doc.html">Help</a></li>
    34. 

  34. </ul>
    35. 

  35. </div>
    36. 

  36. <div class="subNav">
    37. 

  37. <ul class="navList">
    38. 

  38. <li><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/ResourcesMatch.html" title="class in org.apache.tools.ant.taskdefs.condition"><span class="strong">Prev Class</span></a></li>
    39. 

  39. <li><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/TypeFound.html" title="class in org.apache.tools.ant.taskdefs.condition"><span class="strong">Next Class</span></a></li>
    40. 

  40. </ul>
    41. 

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

  42. <li><a href="../../../../../../index.html?org/apache/tools/ant/taskdefs/condition/Socket.html" target="_top">Frames</a></li>
    43. 

  43. <li><a href="Socket.html" target="_top">No Frames</a></li>
    44. 

  44. </ul>
    45. 

  45. <ul class="navList" id="allclasses_navbar_top">
    46. 

  46. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    47. 

  47. </ul>
    48. 

  48. <div>
    49. 

  49. <script type="text/javascript"><!--
    50. 

  50.   allClassesLink = document.getElementById("allclasses_navbar_top");
    51. 

  51.   if(window==top) {
    52. 

  52.     allClassesLink.style.display = "block";
    53. 

  53.   }
    54. 

  54.   else {
    55. 

  55.     allClassesLink.style.display = "none";
    56. 

  56.   }
    57. 

  57.   //-->
    58. 

  58. </script>
    59. 

  59. </div>
    60. 

  60. <div>
    61. 

  61. <ul class="subNavList">
    62. 

  62. <li>Summary:&nbsp;</li>
    63. 

  63. <li>Nested&nbsp;|&nbsp;</li>
    64. 

  64. <li><a href="#fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">Field</a>&nbsp;|&nbsp;</li>
    65. 

  65. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    66. 

  66. <li><a href="#method_summary">Method</a></li>
    67. 

  67. </ul>
    68. 

  68. <ul class="subNavList">
    69. 

  69. <li>Detail:&nbsp;</li>
    70. 

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

  71. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    72. 

  72. <li><a href="#method_detail">Method</a></li>
    73. 

  73. </ul>
    74. 

  74. </div>
    75. 

  75. <a name="skip-navbar_top">
    76. 

  76. <!--   -->
    77. 

  77. </a></div>
    78. 

  78. <!-- ========= END OF TOP NAVBAR ========= -->
    79. 

  79. <!-- ======== START OF CLASS DATA ======== -->
    80. 

  80. <div class="header">
    81. 

  81. <div class="subTitle">org.apache.tools.ant.taskdefs.condition</div>
    82. 

  82. <h2 title="Class Socket" class="title">Class Socket</h2>
    83. 

  83. </div>
    84. 

  84. <div class="contentContainer">
    85. 

  85. <ul class="inheritance">
    86. 

  86. <li>java.lang.Object</li>
    87. 

  87. <li>
    88. 

  88. <ul class="inheritance">
    89. 

  89. <li><a href="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
    90. 

  90. <li>
    91. 

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

  92. <li>org.apache.tools.ant.taskdefs.condition.Socket</li>
    93. 

  93. </ul>
    94. 

  94. </li>
    95. 

  95. </ul>
    96. 

  96. </li>
    97. 

  97. </ul>
    98. 

  98. <div class="description">
    99. 

  99. <ul class="blockList">
    100. 

  100. <li class="blockList">
    101. 

  101. <dl>
    102. 

  102. <dt>All Implemented Interfaces:</dt>
    103. 

  103. <dd>java.lang.Cloneable, <a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</a></dd>
    104. 

  104. </dl>
    105. 

  105. <hr>
    106. 

  106. <br>
    107. 

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

  108. extends <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a>
    109. 

  109. implements <a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</a></pre>
    110. 

  110. <div class="block">Condition to wait for a TCP/IP socket to have a listener. Its attributes are:
    111. 

  111.    server - the name of the server.
    112. 

  112.    port - the port number of the socket.</div>
    113. 

  113. <dl><dt><span class="strong">Since:</span></dt>
    114. 

  114.   <dd>Ant 1.5</dd></dl>
    115. 

  115. </li>
    116. 

  116. </ul>
    117. 

  117. </div>
    118. 

  118. <div class="summary">
    119. 

  119. <ul class="blockList">
    120. 

  120. <li class="blockList">
    121. 

  121. <!-- =========== FIELD SUMMARY =========== -->
    122. 

  122. <ul class="blockList">
    123. 

  123. <li class="blockList"><a name="field_summary">
    124. 

  124. <!--   -->
    125. 

  125. </a>
    126. 

  126. <h3>Field Summary</h3>
    127. 

  127. <ul class="blockList">
    128. 

  128. <li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
    129. 

  129. <!--   -->
    130. 

  130. </a>
    131. 

  131. <h3>Fields inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
    132. 

  132. <code><a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
    133. 

  133. </ul>
    134. 

  134. </li>
    135. 

  135. </ul>
    136. 

  136. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    137. 

  137. <ul class="blockList">
    138. 

  138. <li class="blockList"><a name="constructor_summary">
    139. 

  139. <!--   -->
    140. 

  140. </a>
    141. 

  141. <h3>Constructor Summary</h3>
    142. 

  142. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    143. 

  143. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    144. 

  144. <tr>
    145. 

  145. <th class="colOne" scope="col">Constructor and Description</th>
    146. 

  146. </tr>
    147. 

  147. <tr class="altColor">
    148. 

  148. <td class="colOne"><code><strong><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Socket.html#Socket()">Socket</a></strong>()</code>&nbsp;</td>
    149. 

  149. </tr>
    150. 

  150. </table>
    151. 

  151. </li>
    152. 

  152. </ul>
    153. 

  153. <!-- ========== METHOD SUMMARY =========== -->
    154. 

  154. <ul class="blockList">
    155. 

  155. <li class="blockList"><a name="method_summary">
    156. 

  156. <!--   -->
    157. 

  157. </a>
    158. 

  158. <h3>Method Summary</h3>
    159. 

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

  160. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    161. 

  161. <tr>
    162. 

  162. <th class="colFirst" scope="col">Modifier and Type</th>
    163. 

  163. <th class="colLast" scope="col">Method and Description</th>
    164. 

  164. </tr>
    165. 

  165. <tr class="altColor">
    166. 

  166. <td class="colFirst"><code>boolean</code></td>
    167. 

  167. <td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Socket.html#eval()">eval</a></strong>()</code>
    168. 

  168. <div class="block">Is this condition true?</div>
    169. 

  169. </td>
    170. 

  170. </tr>
    171. 

  171. <tr class="rowColor">
    172. 

  172. <td class="colFirst"><code>void</code></td>
    173. 

  173. <td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Socket.html#setPort(int)">setPort</a></strong>(int&nbsp;port)</code>
    174. 

  174. <div class="block">Set the port attribute</div>
    175. 

  175. </td>
    176. 

  176. </tr>
    177. 

  177. <tr class="altColor">
    178. 

  178. <td class="colFirst"><code>void</code></td>
    179. 

  179. <td class="colLast"><code><strong><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Socket.html#setServer(java.lang.String)">setServer</a></strong>(java.lang.String&nbsp;server)</code>
    180. 

  180. <div class="block">Set the server attribute</div>
    181. 

  181. </td>
    182. 

  182. </tr>
    183. 

  183. </table>
    184. 

  184. <ul class="blockList">
    185. 

  185. <li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
    186. 

  186. <!--   -->
    187. 

  187. </a>
    188. 

  188. <h3>Methods inherited from class&nbsp;org.apache.tools.ant.<a href="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a></h3>
    189. 

  189. <code><a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
    190. 

  190. </ul>
    191. 

  191. <ul class="blockList">
    192. 

  192. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
    193. 

  193. <!--   -->
    194. 

  194. </a>
    195. 

  195. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    196. 

  196. <code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
    197. 

  197. </ul>
    198. 

  198. </li>
    199. 

  199. </ul>
    200. 

  200. </li>
    201. 

  201. </ul>
    202. 

  202. </div>
    203. 

  203. <div class="details">
    204. 

  204. <ul class="blockList">
    205. 

  205. <li class="blockList">
    206. 

  206. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    207. 

  207. <ul class="blockList">
    208. 

  208. <li class="blockList"><a name="constructor_detail">
    209. 

  209. <!--   -->
    210. 

  210. </a>
    211. 

  211. <h3>Constructor Detail</h3>
    212. 

  212. <a name="Socket()">
    213. 

  213. <!--   -->
    214. 

  214. </a>
    215. 

  215. <ul class="blockListLast">
    216. 

  216. <li class="blockList">
    217. 

  217. <h4>Socket</h4>
    218. 

  218. <pre>public&nbsp;Socket()</pre>
    219. 

  219. </li>
    220. 

  220. </ul>
    221. 

  221. </li>
    222. 

  222. </ul>
    223. 

  223. <!-- ============ METHOD DETAIL ========== -->
    224. 

  224. <ul class="blockList">
    225. 

  225. <li class="blockList"><a name="method_detail">
    226. 

  226. <!--   -->
    227. 

  227. </a>
    228. 

  228. <h3>Method Detail</h3>
    229. 

  229. <a name="setServer(java.lang.String)">
    230. 

  230. <!--   -->
    231. 

  231. </a>
    232. 

  232. <ul class="blockList">
    233. 

  233. <li class="blockList">
    234. 

  234. <h4>setServer</h4>
    235. 

  235. <pre>public&nbsp;void&nbsp;setServer(java.lang.String&nbsp;server)</pre>
    236. 

  236. <div class="block">Set the server attribute</div>
    237. 

  237. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>server</code> - the server name</dd></dl>
    238. 

  238. </li>
    239. 

  239. </ul>
    240. 

  240. <a name="setPort(int)">
    241. 

  241. <!--   -->
    242. 

  242. </a>
    243. 

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

  244. <li class="blockList">
    245. 

  245. <h4>setPort</h4>
    246. 

  246. <pre>public&nbsp;void&nbsp;setPort(int&nbsp;port)</pre>
    247. 

  247. <div class="block">Set the port attribute</div>
    248. 

  248. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - the port number of the socket</dd></dl>
    249. 

  249. </li>
    250. 

  250. </ul>
    251. 

  251. <a name="eval()">
    252. 

  252. <!--   -->
    253. 

  253. </a>
    254. 

  254. <ul class="blockListLast">
    255. 

  255. <li class="blockList">
    256. 

  256. <h4>eval</h4>
    257. 

  257. <pre>public&nbsp;boolean&nbsp;eval()
    258. 

  258.              throws <a href="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
    259. 

  259. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html#eval()">Condition</a></code></strong></div>
    260. 

  260. <div class="block">Is this condition true?</div>
    261. 

  261. <dl>
    262. 

  262. <dt><strong>Specified by:</strong></dt>
    263. 

  263. <dd><code><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html#eval()">eval</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</a></code></dd>
    264. 

  264. <dt><span class="strong">Returns:</span></dt><dd>true if a socket can be created</dd>
    265. 

  265. <dt><span class="strong">Throws:</span></dt>
    266. 

  266. <dd><code><a href="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if the attributes are not set</dd></dl>
    267. 

  267. </li>
    268. 

  268. </ul>
    269. 

  269. </li>
    270. 

  270. </ul>
    271. 

  271. </li>
    272. 

  272. </ul>
    273. 

  273. </div>
    274. 

  274. </div>
    275. 

  275. <!-- ========= END OF CLASS DATA ========= -->
    276. 

  276. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    277. 

  277. <div class="bottomNav"><a name="navbar_bottom">
    278. 

  278. <!--   -->
    279. 

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

  280. <!--   -->
    281. 

  281. </a>
    282. 

  282. <ul class="navList" title="Navigation">
    283. 

  283. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
    284. 

  284. <li><a href="package-summary.html">Package</a></li>
    285. 

  285. <li class="navBarCell1Rev">Class</li>
    286. 

  286. <li><a href="package-tree.html">Tree</a></li>
    287. 

  287. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
    288. 

  288. <li><a href="../../../../../../index-all.html">Index</a></li>
    289. 

  289. <li><a href="../../../../../../help-doc.html">Help</a></li>
    290. 

  290. </ul>
    291. 

  291. </div>
    292. 

  292. <div class="subNav">
    293. 

  293. <ul class="navList">
    294. 

  294. <li><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/ResourcesMatch.html" title="class in org.apache.tools.ant.taskdefs.condition"><span class="strong">Prev Class</span></a></li>
    295. 

  295. <li><a href="../../../../../../org/apache/tools/ant/taskdefs/condition/TypeFound.html" title="class in org.apache.tools.ant.taskdefs.condition"><span class="strong">Next Class</span></a></li>
    296. 

  296. </ul>
    297. 

  297. <ul class="navList">
    298. 

  298. <li><a href="../../../../../../index.html?org/apache/tools/ant/taskdefs/condition/Socket.html" target="_top">Frames</a></li>
    299. 

  299. <li><a href="Socket.html" target="_top">No Frames</a></li>
    300. 

  300. </ul>
    301. 

  301. <ul class="navList" id="allclasses_navbar_bottom">
    302. 

  302. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
    303. 

  303. </ul>
    304. 

  304. <div>
    305. 

  305. <script type="text/javascript"><!--
    306. 

  306.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    307. 

  307.   if(window==top) {
    308. 

  308.     allClassesLink.style.display = "block";
    309. 

  309.   }
    310. 

  310.   else {
    311. 

  311.     allClassesLink.style.display = "none";
    312. 

  312.   }
    313. 

  313.   //-->
    314. 

  314. </script>
    315. 

  315. </div>
    316. 

  316. <div>
    317. 

  317. <ul class="subNavList">
    318. 

  318. <li>Summary:&nbsp;</li>
    319. 

  319. <li>Nested&nbsp;|&nbsp;</li>
    320. 

  320. <li><a href="#fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">Field</a>&nbsp;|&nbsp;</li>
    321. 

  321. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    322. 

  322. <li><a href="#method_summary">Method</a></li>
    323. 

  323. </ul>
    324. 

  324. <ul class="subNavList">
    325. 

  325. <li>Detail:&nbsp;</li>
    326. 

  326. <li>Field&nbsp;|&nbsp;</li>
    327. 

  327. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    328. 

  328. <li><a href="#method_detail">Method</a></li>
    329. 

  329. </ul>
    330. 

  330. </div>
    331. 

  331. <a name="skip-navbar_bottom">
    332. 

  332. <!--   -->
    333. 

  333. </a></div>
    334. 

  334. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    335. 

  335. </body>
    336. 

  336. </html>
    337. 

  337.