Skip to content

Commit

Permalink
Javadoc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
mnlipp committed Apr 29, 2024
1 parent 6260e9d commit e999747
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,14 @@
import java.nio.Buffer;
import java.nio.charset.Charset;
import java.util.function.Consumer;
import org.jgrapes.io.events.Input;

/**
* Starts a thread with a synchronous consumer of input provided by a
* {@link Reader} which is fed with data from {@link ManagedBuffer}s
* (usually obtained from {@link Input} events).
*
* @since 2.8.0
*/
public class ManagedBufferStreamer {

Expand Down Expand Up @@ -53,15 +59,9 @@ public ManagedBufferStreamer charset(Charset charset) {
}

/**
* Feed data to the reader. The call blocks while data from a previous
* invocation has not been fully read. The buffer passed as argument
* is locked (see {@link ManagedBuffer#lockBuffer()}) until all
* data has been read.
* Feed data to underlying the reader
* (see {@link ManagedBufferReader#feed).
*
* Calling this method with `null` as argument closes the feed.
* After consuming any data still available from a previous
* invocation, further calls to {@link #read} therefore return -1.
*
* @param buffer the buffer
* @throws IOException Signals that an I/O exception has occurred.
*/
Expand Down
2 changes: 2 additions & 0 deletions org.jgrapes.io/src/org/jgrapes/io/util/ThreadCleaner.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
* this class allows the thread to be associated with the lifetime of an
* arbitrary object. When the object is garbage collected, the thread is
* terminated automatically.
*
* @since 2.8.0
*/
public class ThreadCleaner {

Expand Down
7 changes: 3 additions & 4 deletions org.jgrapes.io/src/org/jgrapes/net/SslCodec.java
Original file line number Diff line number Diff line change
Expand Up @@ -269,11 +269,10 @@ public void onPurge(Purge event, IOSubchannel encryptedChannel) {
/**
* Handles an {@link IOError} event from the encrypted channel (client)
* by sending it downstream.
*
*
* @param event the event
* @param encryptedChannel the channel for exchanging the encrypted data
* @throws InterruptedException
* @throws SSLException
* @throws SSLException the SSL exception
* @throws InterruptedException the interrupted exception
*/
@Handler(channels = EncryptedChannel.class, excludeSelf = true)
public void onIOError(IOError event)
Expand Down

0 comments on commit e999747

Please sign in to comment.