You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2008/06/03 21:53:20 UTC
svn commit: r662867 - in
/mina/trunk/core/src/main/java/org/apache/mina/common:
AbstractIoAcceptor.java AbstractIoConnector.java AbstractIoService.java
AbstractIoSession.java AbstractIoSessionConfig.java
AbstractPollingConnectionlessIoAcceptor.java
Author: elecharny
Date: Tue Jun 3 12:53:20 2008
New Revision: 662867
URL: http://svn.apache.org/viewvc?rev=662867&view=rev
Log:
o Added a lot of missing @{inheritDoc}
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoAcceptor.java
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoConnector.java
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSession.java
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSessionConfig.java
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.java
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoAcceptor.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoAcceptor.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoAcceptor.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoAcceptor.java Tue Jun 3 12:53:20 2008
@@ -60,6 +60,9 @@
defaultLocalAddresses.add(null);
}
+ /**
+ * {@inheritDoc}
+ */
public SocketAddress getLocalAddress() {
Set<SocketAddress> localAddresses = getLocalAddresses();
if (localAddresses.isEmpty()) {
@@ -69,6 +72,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final Set<SocketAddress> getLocalAddresses() {
Set<SocketAddress> localAddresses = new HashSet<SocketAddress>();
synchronized (bindLock) {
@@ -77,6 +83,9 @@
return localAddresses;
}
+ /**
+ * {@inheritDoc}
+ */
public SocketAddress getDefaultLocalAddress() {
if (defaultLocalAddresses.isEmpty()) {
return null;
@@ -84,14 +93,23 @@
return defaultLocalAddresses.iterator().next();
}
+ /**
+ * {@inheritDoc}
+ */
public final void setDefaultLocalAddress(SocketAddress localAddress) {
setDefaultLocalAddresses(localAddress);
}
+ /**
+ * {@inheritDoc}
+ */
public final List<SocketAddress> getDefaultLocalAddresses() {
return unmodifiableDefaultLocalAddresses;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setDefaultLocalAddresses(List<? extends SocketAddress> localAddresses) {
if (localAddresses == null) {
throw new NullPointerException("localAddresses");
@@ -99,6 +117,9 @@
setDefaultLocalAddresses((Iterable<? extends SocketAddress>) localAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final void setDefaultLocalAddresses(Iterable<? extends SocketAddress> localAddresses) {
if (localAddresses == null) {
throw new NullPointerException("localAddresses");
@@ -126,6 +147,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final void setDefaultLocalAddresses(SocketAddress firstLocalAddress, SocketAddress... otherLocalAddresses) {
if (otherLocalAddresses == null) {
otherLocalAddresses = new SocketAddress[0];
@@ -142,18 +166,30 @@
setDefaultLocalAddresses(newLocalAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isCloseOnDeactivation() {
return disconnectOnUnbind;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setCloseOnDeactivation(boolean disconnectClientsOnUnbind) {
this.disconnectOnUnbind = disconnectClientsOnUnbind;
}
+ /**
+ * {@inheritDoc}
+ */
public final void bind() throws IOException {
bind(getDefaultLocalAddresses());
}
+ /**
+ * {@inheritDoc}
+ */
public final void bind(SocketAddress localAddress) throws IOException {
if (localAddress == null) {
throw new NullPointerException("localAddress");
@@ -164,6 +200,9 @@
bind(localAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final void bind(
SocketAddress firstLocalAddress,
SocketAddress... otherLocalAddresses) throws IOException {
@@ -180,6 +219,9 @@
bind(localAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final void bind(Iterable<? extends SocketAddress> localAddresses) throws IOException {
if (isDisposing()) {
throw new IllegalStateException("Already disposed.");
@@ -224,10 +266,16 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final void unbind() {
unbind(getLocalAddresses());
}
+ /**
+ * {@inheritDoc}
+ */
public final void unbind(SocketAddress localAddress) {
if (localAddress == null) {
throw new NullPointerException("localAddress");
@@ -238,6 +286,9 @@
unbind(localAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final void unbind(SocketAddress firstLocalAddress,
SocketAddress... otherLocalAddresses) {
if (firstLocalAddress == null) {
@@ -253,6 +304,9 @@
unbind(localAddresses);
}
+ /**
+ * {@inheritDoc}
+ */
public final void unbind(Iterable<? extends SocketAddress> localAddresses) {
if (localAddresses == null) {
throw new NullPointerException("localAddresses");
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoConnector.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoConnector.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoConnector.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoConnector.java Tue Jun 3 12:53:20 2008
@@ -68,6 +68,9 @@
return (int)connectTimeoutInMillis/1000;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getConnectTimeoutMillis() {
return connectTimeoutInMillis;
}
@@ -92,10 +95,16 @@
this.connectTimeoutInMillis = connectTimeoutInMillis;
}
+ /**
+ * {@inheritDoc}
+ */
public SocketAddress getDefaultRemoteAddress() {
return defaultRemoteAddress;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setDefaultRemoteAddress(SocketAddress defaultRemoteAddress) {
if (defaultRemoteAddress == null) {
throw new NullPointerException("defaultRemoteAddress");
@@ -110,6 +119,9 @@
this.defaultRemoteAddress = defaultRemoteAddress;
}
+ /**
+ * {@inheritDoc}
+ */
public final ConnectFuture connect() {
SocketAddress defaultRemoteAddress = getDefaultRemoteAddress();
if (defaultRemoteAddress == null) {
@@ -119,6 +131,9 @@
return connect(defaultRemoteAddress, null, null);
}
+ /**
+ * {@inheritDoc}
+ */
public ConnectFuture connect(IoSessionInitializer<? extends ConnectFuture> sessionInitializer) {
SocketAddress defaultRemoteAddress = getDefaultRemoteAddress();
if (defaultRemoteAddress == null) {
@@ -128,20 +143,32 @@
return connect(defaultRemoteAddress, null, sessionInitializer);
}
+ /**
+ * {@inheritDoc}
+ */
public final ConnectFuture connect(SocketAddress remoteAddress) {
return connect(remoteAddress, null, null);
}
+ /**
+ * {@inheritDoc}
+ */
public ConnectFuture connect(SocketAddress remoteAddress,
IoSessionInitializer<? extends ConnectFuture> sessionInitializer) {
return connect(remoteAddress, null, sessionInitializer);
}
+ /**
+ * {@inheritDoc}
+ */
public ConnectFuture connect(SocketAddress remoteAddress,
SocketAddress localAddress) {
return connect(remoteAddress, localAddress, null);
}
+ /**
+ * {@inheritDoc}
+ */
public final ConnectFuture connect(SocketAddress remoteAddress,
SocketAddress localAddress, IoSessionInitializer<? extends ConnectFuture> sessionInitializer) {
if (isDisposing()) {
@@ -236,6 +263,9 @@
});
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String toString() {
TransportMetadata m = getTransportMetadata();
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java Tue Jun 3 12:53:20 2008
@@ -175,10 +175,16 @@
executeWorker(idleStatusChecker.getNotifyingTask(), "idleStatusChecker");
}
+ /**
+ * {@inheritDoc}
+ */
public final IoFilterChainBuilder getFilterChainBuilder() {
return filterChainBuilder;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setFilterChainBuilder(IoFilterChainBuilder builder) {
if (builder == null) {
builder = new DefaultIoFilterChainBuilder();
@@ -186,6 +192,9 @@
filterChainBuilder = builder;
}
+ /**
+ * {@inheritDoc}
+ */
public final DefaultIoFilterChainBuilder getFilterChain() {
if (filterChainBuilder instanceof DefaultIoFilterChainBuilder) {
return (DefaultIoFilterChainBuilder) filterChainBuilder;
@@ -195,26 +204,44 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final void addListener(IoServiceListener listener) {
listeners.add(listener);
}
+ /**
+ * {@inheritDoc}
+ */
public final void removeListener(IoServiceListener listener) {
listeners.remove(listener);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isActive() {
return listeners.isActive();
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isDisposing() {
return disposing;
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isDisposed() {
return disposed;
}
+ /**
+ * {@inheritDoc}
+ */
public final void dispose() {
if (disposed) {
return;
@@ -262,26 +289,44 @@
*/
protected abstract IoFuture dispose0() throws Exception;
+ /**
+ * {@inheritDoc}
+ */
public final Map<Long, IoSession> getManagedSessions() {
return listeners.getManagedSessions();
}
+ /**
+ * {@inheritDoc}
+ */
public final long getCumulativeManagedSessionCount() {
return listeners.getCumulativeManagedSessionCount();
}
+ /**
+ * {@inheritDoc}
+ */
public final int getLargestManagedSessionCount() {
return listeners.getLargestManagedSessionCount();
}
+ /**
+ * {@inheritDoc}
+ */
public final int getManagedSessionCount() {
return listeners.getManagedSessionCount();
}
+ /**
+ * {@inheritDoc}
+ */
public final IoHandler getHandler() {
return handler;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setHandler(IoHandler handler) {
if (handler == null) {
throw new NullPointerException("handler");
@@ -294,14 +339,23 @@
this.handler = handler;
}
+ /**
+ * {@inheritDoc}
+ */
public IoSessionConfig getSessionConfig() {
return sessionConfig;
}
+ /**
+ * {@inheritDoc}
+ */
public final IoSessionDataStructureFactory getSessionDataStructureFactory() {
return sessionDataStructureFactory;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setSessionDataStructureFactory(IoSessionDataStructureFactory sessionDataStructureFactory) {
if (sessionDataStructureFactory == null) {
throw new NullPointerException("sessionDataStructureFactory");
@@ -315,6 +369,9 @@
this.sessionDataStructureFactory = sessionDataStructureFactory;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReadBytes() {
return readBytes.get();
}
@@ -326,6 +383,9 @@
idleCountForRead = 0;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReadMessages() {
return readMessages.get();
}
@@ -337,10 +397,16 @@
idleCountForRead = 0;
}
+ /**
+ * {@inheritDoc}
+ */
public final int getThroughputCalculationInterval() {
return throughputCalculationInterval;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setThroughputCalculationInterval(int throughputCalculationInterval) {
if (throughputCalculationInterval < 0) {
throw new IllegalArgumentException(
@@ -350,42 +416,69 @@
this.throughputCalculationInterval = throughputCalculationInterval;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getThroughputCalculationIntervalInMillis() {
return throughputCalculationInterval * 1000L;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getReadBytesThroughput() {
resetThroughput();
return readBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getWrittenBytesThroughput() {
resetThroughput();
return writtenBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getReadMessagesThroughput() {
resetThroughput();
return readMessagesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getWrittenMessagesThroughput() {
resetThroughput();
return writtenMessagesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getLargestReadBytesThroughput() {
return largestReadBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getLargestWrittenBytesThroughput() {
return largestWrittenBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getLargestReadMessagesThroughput() {
return largestReadMessagesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getLargestWrittenMessagesThroughput() {
return largestWrittenMessagesThroughput;
}
@@ -439,6 +532,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final int getScheduledWriteBytes() {
return scheduledWriteBytes.get();
}
@@ -447,6 +543,9 @@
scheduledWriteBytes.addAndGet(increment);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getScheduledWriteMessages() {
return scheduledWriteMessages.get();
}
@@ -459,14 +558,23 @@
scheduledWriteMessages.decrementAndGet();
}
+ /**
+ * {@inheritDoc}
+ */
public final long getActivationTime() {
return listeners.getActivationTime();
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastIoTime() {
return Math.max(lastReadTime, lastWriteTime);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastReadTime() {
return lastReadTime;
}
@@ -475,6 +583,9 @@
this.lastReadTime = lastReadTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastWriteTime() {
return lastWriteTime;
}
@@ -483,6 +594,9 @@
this.lastWriteTime = lastWriteTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWrittenBytes() {
return writtenBytes.get();
}
@@ -494,6 +608,9 @@
idleCountForWrite = 0;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWrittenMessages() {
return writtenMessages.get();
}
@@ -505,6 +622,9 @@
idleCountForWrite = 0;
}
+ /**
+ * {@inheritDoc}
+ */
public final int getIdleTime(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return idleTimeForBoth;
@@ -521,10 +641,16 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getIdleTimeInMillis(IdleStatus status) {
return getIdleTime(status) * 1000L;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setIdleTime(IdleStatus status, int idleTime) {
if (idleTime < 0) {
throw new IllegalArgumentException("Illegal idle time: " + idleTime);
@@ -551,6 +677,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isIdle(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return idleCountForBoth > 0;
@@ -567,6 +696,9 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getIdleCount(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return idleCountForBoth;
@@ -583,6 +715,9 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastIdleTime(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return lastIdleTimeForBoth;
@@ -650,78 +785,135 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final int getBothIdleCount() {
return getIdleCount(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastBothIdleTime() {
return getLastIdleTime(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastReaderIdleTime() {
return getLastIdleTime(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastWriterIdleTime() {
return getLastIdleTime(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getReaderIdleCount() {
return getIdleCount(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getWriterIdleCount() {
return getIdleCount(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getBothIdleTime() {
return getIdleTime(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getBothIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getReaderIdleTime() {
return getIdleTime(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReaderIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getWriterIdleTime() {
return getIdleTime(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWriterIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isBothIdle() {
return isIdle(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isReaderIdle() {
return isIdle(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isWriterIdle() {
return isIdle(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final void setBothIdleTime(int idleTime) {
setIdleTime(IdleStatus.BOTH_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public final void setReaderIdleTime(int idleTime) {
setIdleTime(IdleStatus.READER_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public final void setWriterIdleTime(int idleTime) {
setIdleTime(IdleStatus.WRITER_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public final Set<WriteFuture> broadcast(Object message) {
// Convert to Set. We do not return a List here because only the
// direct caller of MessageBroadcaster knows the order of write
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSession.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSession.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSession.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSession.java Tue Jun 3 12:53:20 2008
@@ -120,6 +120,9 @@
closeFuture.addListener(SCHEDULED_COUNTER_RESETTER);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getId() {
return hashCode() & 0xFFFFFFFFL;
}
@@ -127,14 +130,23 @@
@SuppressWarnings("unchecked")
protected abstract IoProcessor getProcessor();
+ /**
+ * {@inheritDoc}
+ */
public final boolean isConnected() {
return !closeFuture.isClosed();
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isClosing() {
return closing || closeFuture.isClosed();
}
+ /**
+ * {@inheritDoc}
+ */
public final CloseFuture getCloseFuture() {
return closeFuture;
}
@@ -152,6 +164,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final CloseFuture close(boolean rightNow) {
if (rightNow) {
return close();
@@ -160,6 +175,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final CloseFuture close() {
synchronized (lock) {
if (isClosing()) {
@@ -173,13 +191,18 @@
return closeFuture;
}
- @SuppressWarnings("unchecked")
+ /**
+ * {@inheritDoc}
+ */
public final CloseFuture closeOnFlush() {
getWriteRequestQueue().offer(this, CLOSE_REQUEST);
getProcessor().flush(this);
return closeFuture;
}
+ /**
+ * {@inheritDoc}
+ */
public final ReadFuture read() {
if (!getConfig().isUseReadOperation()) {
throw new IllegalStateException("useReadOperation is not enabled.");
@@ -232,7 +255,6 @@
return future;
}
- @SuppressWarnings("unchecked")
private Queue<ReadFuture> getReadyReadFutures() {
Queue<ReadFuture> readyReadFutures =
(Queue<ReadFuture>) getAttribute(READY_READ_FUTURES);
@@ -249,7 +271,6 @@
return readyReadFutures;
}
- @SuppressWarnings("unchecked")
private Queue<ReadFuture> getWaitingReadFutures() {
Queue<ReadFuture> waitingReadyReadFutures =
(Queue<ReadFuture>) getAttribute(WAITING_READ_FUTURES);
@@ -266,10 +287,16 @@
return waitingReadyReadFutures;
}
+ /**
+ * {@inheritDoc}
+ */
public final WriteFuture write(Object message) {
return write(message, null);
}
+ /**
+ * {@inheritDoc}
+ */
public final WriteFuture write(Object message, SocketAddress remoteAddress) {
if (message == null) {
throw new NullPointerException("message");
@@ -327,54 +354,93 @@
return future;
}
+ /**
+ * {@inheritDoc}
+ */
public final Object getAttachment() {
return getAttribute("");
}
+ /**
+ * {@inheritDoc}
+ */
public final Object setAttachment(Object attachment) {
return setAttribute("", attachment);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object getAttribute(Object key) {
return getAttribute(key, null);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object getAttribute(Object key, Object defaultValue) {
return attributes.getAttribute(this, key, defaultValue);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object setAttribute(Object key, Object value) {
return attributes.setAttribute(this, key, value);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object setAttribute(Object key) {
return setAttribute(key, Boolean.TRUE);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object setAttributeIfAbsent(Object key, Object value) {
return attributes.setAttributeIfAbsent(this, key, value);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object setAttributeIfAbsent(Object key) {
return setAttributeIfAbsent(key, Boolean.TRUE);
}
+ /**
+ * {@inheritDoc}
+ */
public final Object removeAttribute(Object key) {
return attributes.removeAttribute(this, key);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean removeAttribute(Object key, Object value) {
return attributes.removeAttribute(this, key, value);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean replaceAttribute(Object key, Object oldValue, Object newValue) {
return attributes.replaceAttribute(this, key, oldValue, newValue);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean containsAttribute(Object key) {
return attributes.containsAttribute(this, key);
}
+ /**
+ * {@inheritDoc}
+ */
public final Set<Object> getAttributeKeys() {
return attributes.getAttributeKeys(this);
}
@@ -392,10 +458,16 @@
new CloseRequestAwareWriteRequestQueue(writeRequestQueue);
}
+ /**
+ * {@inheritDoc}
+ */
public final TrafficMask getTrafficMask() {
return trafficMask;
}
+ /**
+ * {@inheritDoc}
+ */
public final void setTrafficMask(TrafficMask trafficMask) {
if (trafficMask == null) {
throw new NullPointerException("trafficMask");
@@ -412,50 +484,86 @@
this.trafficMask = trafficMask;
}
+ /**
+ * {@inheritDoc}
+ */
public final void suspendRead() {
setTrafficMask(getTrafficMask().and(TrafficMask.READ.not()));
}
+ /**
+ * {@inheritDoc}
+ */
public final void suspendWrite() {
setTrafficMask(getTrafficMask().and(TrafficMask.WRITE.not()));
}
+ /**
+ * {@inheritDoc}
+ */
public final void resumeRead() {
setTrafficMask(getTrafficMask().or(TrafficMask.READ));
}
+ /**
+ * {@inheritDoc}
+ */
public final void resumeWrite() {
setTrafficMask(getTrafficMask().or(TrafficMask.WRITE));
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReadBytes() {
return readBytes;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWrittenBytes() {
return writtenBytes;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReadMessages() {
return readMessages;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWrittenMessages() {
return writtenMessages;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getReadBytesThroughput() {
return readBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getWrittenBytesThroughput() {
return writtenBytesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getReadMessagesThroughput() {
return readMessagesThroughput;
}
+ /**
+ * {@inheritDoc}
+ */
public final double getWrittenMessagesThroughput() {
return writtenMessagesThroughput;
}
@@ -494,10 +602,16 @@
lastThroughputCalculationTime = currentTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getScheduledWriteBytes() {
return scheduledWriteBytes.get();
}
+ /**
+ * {@inheritDoc}
+ */
public final int getScheduledWriteMessages() {
return scheduledWriteMessages.get();
}
@@ -614,10 +728,16 @@
return writeRequestQueue;
}
+ /**
+ * {@inheritDoc}
+ */
public final WriteRequest getCurrentWriteRequest() {
return currentWriteRequest;
}
+ /**
+ * {@inheritDoc}
+ */
public final Object getCurrentWriteMessage() {
WriteRequest req = getCurrentWriteRequest();
if (req == null) {
@@ -654,22 +774,37 @@
deferDecreaseReadBuffer = true;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getCreationTime() {
return creationTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastIoTime() {
return Math.max(lastReadTime, lastWriteTime);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastReadTime() {
return lastReadTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastWriteTime() {
return lastWriteTime;
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isIdle(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return idleCountForBoth > 0;
@@ -686,18 +821,30 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isBothIdle() {
return isIdle(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isReaderIdle() {
return isIdle(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final boolean isWriterIdle() {
return isIdle(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getIdleCount(IdleStatus status) {
if (getConfig().getIdleTime(status) == 0) {
if (status == IdleStatus.BOTH_IDLE) {
@@ -728,6 +875,9 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastIdleTime(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return lastIdleTimeForBoth;
@@ -759,30 +909,51 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final int getBothIdleCount() {
return getIdleCount(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastBothIdleTime() {
return getLastIdleTime(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastReaderIdleTime() {
return getLastIdleTime(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getLastWriterIdleTime() {
return getLastIdleTime(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getReaderIdleCount() {
return getIdleCount(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getWriterIdleCount() {
return getIdleCount(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public SocketAddress getServiceAddress() {
IoService service = getService();
if (service instanceof IoAcceptor) {
@@ -792,16 +963,25 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public final int hashCode() {
return super.hashCode();
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public final boolean equals(Object o) {
return super.equals(o);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String toString() {
if (getService() instanceof IoAcceptor) {
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSessionConfig.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSessionConfig.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSessionConfig.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoSessionConfig.java Tue Jun 3 12:53:20 2008
@@ -41,6 +41,9 @@
protected AbstractIoSessionConfig() {
}
+ /**
+ * {@inheritDoc}
+ */
public final void setAll(IoSessionConfig config) {
if (config == null) {
throw new NullPointerException("config");
@@ -65,10 +68,16 @@
*/
protected abstract void doSetAll(IoSessionConfig config);
+ /**
+ * {@inheritDoc}
+ */
public int getReadBufferSize() {
return readBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public void setReadBufferSize(int readBufferSize) {
if (readBufferSize <= 0) {
throw new IllegalArgumentException("readBufferSize: " + readBufferSize + " (expected: 1+)");
@@ -76,10 +85,16 @@
this.readBufferSize = readBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public int getMinReadBufferSize() {
return minReadBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public void setMinReadBufferSize(int minReadBufferSize) {
if (minReadBufferSize <= 0) {
throw new IllegalArgumentException("minReadBufferSize: " + minReadBufferSize + " (expected: 1+)");
@@ -91,10 +106,16 @@
this.minReadBufferSize = minReadBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public int getMaxReadBufferSize() {
return maxReadBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public void setMaxReadBufferSize(int maxReadBufferSize) {
if (maxReadBufferSize <= 0) {
throw new IllegalArgumentException("maxReadBufferSize: " + maxReadBufferSize + " (expected: 1+)");
@@ -107,6 +128,9 @@
this.maxReadBufferSize = maxReadBufferSize;
}
+ /**
+ * {@inheritDoc}
+ */
public int getIdleTime(IdleStatus status) {
if (status == IdleStatus.BOTH_IDLE) {
return idleTimeForBoth;
@@ -123,10 +147,16 @@
throw new IllegalArgumentException("Unknown idle status: " + status);
}
+ /**
+ * {@inheritDoc}
+ */
public long getIdleTimeInMillis(IdleStatus status) {
return getIdleTime(status) * 1000L;
}
+ /**
+ * {@inheritDoc}
+ */
public void setIdleTime(IdleStatus status, int idleTime) {
if (idleTime < 0) {
throw new IllegalArgumentException("Illegal idle time: " + idleTime);
@@ -143,50 +173,86 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final int getBothIdleTime() {
return getIdleTime(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getBothIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.BOTH_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getReaderIdleTime() {
return getIdleTime(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getReaderIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.READER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final int getWriterIdleTime() {
return getIdleTime(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public final long getWriterIdleTimeInMillis() {
return getIdleTimeInMillis(IdleStatus.WRITER_IDLE);
}
+ /**
+ * {@inheritDoc}
+ */
public void setBothIdleTime(int idleTime) {
setIdleTime(IdleStatus.BOTH_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public void setReaderIdleTime(int idleTime) {
setIdleTime(IdleStatus.READER_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public void setWriterIdleTime(int idleTime) {
setIdleTime(IdleStatus.WRITER_IDLE, idleTime);
}
+ /**
+ * {@inheritDoc}
+ */
public int getWriteTimeout() {
return writeTimeout;
}
+ /**
+ * {@inheritDoc}
+ */
public long getWriteTimeoutInMillis() {
return writeTimeout * 1000L;
}
+ /**
+ * {@inheritDoc}
+ */
public void setWriteTimeout(int writeTimeout) {
if (writeTimeout < 0) {
throw new IllegalArgumentException("Illegal write timeout: "
@@ -195,18 +261,30 @@
this.writeTimeout = writeTimeout;
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isUseReadOperation() {
return useReadOperation;
}
+ /**
+ * {@inheritDoc}
+ */
public void setUseReadOperation(boolean useReadOperation) {
this.useReadOperation = useReadOperation;
}
+ /**
+ * {@inheritDoc}
+ */
public int getThroughputCalculationInterval() {
return throughputCalculationInterval;
}
+ /**
+ * {@inheritDoc}
+ */
public void setThroughputCalculationInterval(int throughputCalculationInterval) {
if (throughputCalculationInterval < 0) {
throw new IllegalArgumentException(
@@ -216,6 +294,9 @@
this.throughputCalculationInterval = throughputCalculationInterval;
}
+ /**
+ * {@inheritDoc}
+ */
public long getThroughputCalculationIntervalInMillis() {
return throughputCalculationInterval * 1000L;
}
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.java?rev=662867&r1=662866&r2=662867&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingConnectionlessIoAcceptor.java Tue Jun 3 12:53:20 2008
@@ -106,6 +106,9 @@
protected abstract T newSession(IoProcessor<T> processor, H handle, SocketAddress remoteAddress) throws Exception;
protected abstract void setInterestedInWrite(T session, boolean interested) throws Exception;
+ /**
+ * {@inheritDoc}
+ */
@Override
protected IoFuture dispose0() throws Exception {
unbind();
@@ -116,6 +119,9 @@
return disposalFuture;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
protected final Set<SocketAddress> bind0(
List<? extends SocketAddress> localAddresses) throws Exception {
@@ -138,6 +144,9 @@
return newLocalAddresses;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
protected final void unbind0(
List<? extends SocketAddress> localAddresses) throws Exception {
@@ -154,6 +163,9 @@
}
}
+ /**
+ * {@inheritDoc}
+ */
public final IoSession newSession(SocketAddress remoteAddress, SocketAddress localAddress) {
if (isDisposing()) {
throw new IllegalStateException("Already disposed.");