[CVS spice] Add some javadocs

Commit in spice/sandbox/netevent/src/java/org/codehaus/spice/netevent/source on MAIN

SelectableChannelEventSource.java +11 -1 1.9 -> 1.10

Add some javadocs

----------

spice/sandbox/netevent/src/java/org/codehaus/spice/netevent/source

SelectableChannelEventSource.java 1.9 -> 1.10

diff -u -r1.9 -r1.10
--- SelectableChannelEventSource.java 17 May 2004 05:41:50 -0000 1.9
+++ SelectableChannelEventSource.java 17 May 2004 06:17:27 -0000 1.10
@@ -19,7 +19,7 @@

* An event source that generates events based from SelectableChannels.
*
* @author Peter Donald

- * @version $Revision: 1.9 $ $Date: 2004/05/17 05:41:50 $

+ * @version $Revision: 1.10 $ $Date: 2004/05/17 06:17:27 $

*/
public class SelectableChannelEventSource
extends AbstractEventSource

@@ -47,6 +47,16 @@

open();
}

+ /**
+ * Specify the timeout to use.
+ * Note that this should not be 0 as it can cause a deadlock. If
+ * no events wake up the polling thread and another threads wishes
+ * to request a channel close it is possible that requester will
+ * not be able to aquire lock. In which case it is recomended that
+ * a timeout of 200 or similar is utilized.
+ *
+ * @param selectTimeout the timeout
+ */

public void setSelectTimeout( final long selectTimeout )
{
_selectTimeout = selectTimeout;

CVSspam 0.2.8