From 5a0fce4aa74c646e82379c810e5f3a0537d3bf6c Mon Sep 17 00:00:00 2001
From: Christian Wulf <chw@informatik.uni-kiel.de>
Date: Tue, 20 Jan 2015 05:19:24 +0100
Subject: [PATCH] added hint

---
 src/main/java/teetime/stage/io/AbstractTcpReader.java | 10 ++++++++--
 src/site/markdown/wiki                                |  2 +-
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/src/main/java/teetime/stage/io/AbstractTcpReader.java b/src/main/java/teetime/stage/io/AbstractTcpReader.java
index c7b4e372..5df93077 100644
--- a/src/main/java/teetime/stage/io/AbstractTcpReader.java
+++ b/src/main/java/teetime/stage/io/AbstractTcpReader.java
@@ -38,13 +38,13 @@ public abstract class AbstractTcpReader<T> extends AbstractProducerStage<T> {
 				socketChannel.close();
 			}
 		} catch (final IOException ex) {
-			logger.error("Error while reading", ex);
+			logger.error("Error while reading.", ex);
 		} finally {
 			if (null != serversocket) {
 				try {
 					serversocket.close();
 				} catch (final IOException e) {
-					logger.debug("Failed to close TCP connection!", e);
+					logger.debug("Failed to close TCP connection.", e);
 				}
 			}
 
@@ -66,6 +66,12 @@ public abstract class AbstractTcpReader<T> extends AbstractProducerStage<T> {
 		}
 	}
 
+	/**
+	 * Important note: Do not catch {@link BufferUnderflowException}s since they are caught by the caller to automatically fill the buffer with new content.
+	 *
+	 * @param buffer
+	 *            to be read from
+	 */
 	protected abstract void read(final ByteBuffer buffer);
 
 }
diff --git a/src/site/markdown/wiki b/src/site/markdown/wiki
index cdfd44ee..0e447457 160000
--- a/src/site/markdown/wiki
+++ b/src/site/markdown/wiki
@@ -1 +1 @@
-Subproject commit cdfd44ee829e7bba079ee71983e5711a4e6cb259
+Subproject commit 0e4474577e1f49bc96e734c286b2d9e0363895e8
-- 
GitLab