This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit b62bdb6dc347eeeeff71797c0c37814e8dc5dd9e
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Sep 23 19:01:26 2019 +0100
Remaining Javadoc fixes for Java 13 in org.apache.coyote
---
java/org/apache/coyote/ajp/AjpNioProcessor.java | 21 ++++++++++++++++++++-
java/org/apache/coyote/ajp/AjpProcessor.java | 9 +++++++++
java/org/apache/coyote/ajp/AjpProtocol.java | 6 ++++--
3 files changed, 33 insertions(+), 3 deletions(-)
diff --git a/java/org/apache/coyote/ajp/AjpNioProcessor.java
b/java/org/apache/coyote/ajp/AjpNioProcessor.java
index 8ab67e5..ff100fb 100644
--- a/java/org/apache/coyote/ajp/AjpNioProcessor.java
+++ b/java/org/apache/coyote/ajp/AjpNioProcessor.java
@@ -330,7 +330,21 @@ public class AjpNioProcessor extends
AbstractAjpProcessor<NioChannel> {
/**
- * Read the specified amount of bytes, and place them in the input buffer.
+ * Read at least the specified amount of bytes, and place them
+ * in the input buffer. Note that if any data is available to read then
this
+ * method will always block until at least the specified number of bytes
+ * have been read.
+ *
+ * @param buf Buffer to read data into
+ * @param pos Start position
+ * @param n The minimum number of bytes to read
+ * @param blockFirstRead
+ * If there is no data available to read when this method is
+ * called, should this call block until data becomes
available?
+ *
+ * @return The number of bytes read
+ *
+ * @throws IOException If an I/O error occurs during the read
*/
protected int read(byte[] buf, int pos, int n, boolean blockFirstRead)
throws IOException {
@@ -429,6 +443,11 @@ public class AjpNioProcessor extends
AbstractAjpProcessor<NioChannel> {
/**
* Read an AJP message.
*
+ * @param message The message to populate
+ * @param blockFirstRead
+ * If there is no data available to read when this method is
+ * called, should this call block until data becomes
available?
+ *
* @return The number of bytes read
* @throws IOException any other failure, including incomplete reads
*/
diff --git a/java/org/apache/coyote/ajp/AjpProcessor.java
b/java/org/apache/coyote/ajp/AjpProcessor.java
index 4bf6dbf..1f11948 100644
--- a/java/org/apache/coyote/ajp/AjpProcessor.java
+++ b/java/org/apache/coyote/ajp/AjpProcessor.java
@@ -302,6 +302,13 @@ public class AjpProcessor extends
AbstractAjpProcessor<Socket> {
/**
* Read at least the specified amount of bytes, and place them
* in the input buffer.
+ *
+ * @param buf Buffer to read data into
+ * @param pos Start position
+ * @param n The minimum number of bytes to read
+ * @return <code>true</code> if the requested number of bytes were read
+ * else <code>false</code>
+ * @throws IOException If an I/O error occurs during the read
*/
protected boolean read(byte[] buf, int pos, int n)
throws IOException {
@@ -354,6 +361,8 @@ public class AjpProcessor extends
AbstractAjpProcessor<Socket> {
/**
* Read an AJP message.
*
+ * @param message The message object to populate
+ *
* @return true if the message has been read, false if the short read
* didn't return anything
* @throws IOException any other failure, including incomplete reads
diff --git a/java/org/apache/coyote/ajp/AjpProtocol.java
b/java/org/apache/coyote/ajp/AjpProtocol.java
index f99a99f..50f6f58 100644
--- a/java/org/apache/coyote/ajp/AjpProtocol.java
+++ b/java/org/apache/coyote/ajp/AjpProtocol.java
@@ -116,8 +116,10 @@ public class AjpProtocol extends
AbstractAjpProtocol<Socket> {
* required.
*
* @param socket Ignored for BIO
- * @param processor
- * @param isSocketClosing
+ * @param processor The process that was processing this
+ * connection and is no longer required
+ * @param isSocketClosing Is the socket associated with this
+ * connection in the process of closing
* @param addToPoller Ignored for BIO
*/
@Override
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
