Updated APIviz tags (work in progress)
This commit is contained in:
Trustin Lee
parent
89a4bd9d4e
commit
90329ef978
|
|
@ -26,5 +26,6 @@
|
|||
* typical client side and server side channel initialization.
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.exclude ^org\.jboss\.netty\.util\.
|
||||
*/
|
||||
package org.jboss.netty.bootstrap;
|
||||
|
|
|
|||
|
|
@ -135,6 +135,7 @@
|
|||
* as well as {@link java.nio.ByteBuffer}.
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.exclude ^java\.lang\.
|
||||
* @apiviz.exclude ^java\.io\.[^\.]+Stream$
|
||||
*/
|
||||
package org.jboss.netty.buffer;
|
||||
|
|
@ -24,5 +24,8 @@
|
|||
/**
|
||||
* A virtual transport that enables the communication between the two
|
||||
* parties in the same virtual machine.
|
||||
*
|
||||
* @apiviz.exclude ^java\.lang\.
|
||||
* @apiviz.exclude Channel$
|
||||
*/
|
||||
package org.jboss.netty.channel.local;
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@ import org.jboss.netty.channel.Channel;
|
|||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.composedOf org.jboss.netty.channel.socket.DatagramChannelConfig
|
||||
*/
|
||||
public interface DatagramChannel extends Channel {
|
||||
|
|
|
|||
|
|
@ -68,8 +68,6 @@ import org.jboss.netty.channel.ReceiveBufferSizePredictor;
|
|||
* @author Trustin Lee (tlee@redhat.com)
|
||||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public interface DatagramChannelConfig extends ChannelConfig {
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ import org.jboss.netty.channel.ServerChannel;
|
|||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.composedOf org.jboss.netty.channel.socket.ServerSocketChannelConfig
|
||||
*/
|
||||
public interface ServerSocketChannel extends ServerChannel {
|
||||
|
|
|
|||
|
|
@ -51,8 +51,6 @@ import org.jboss.netty.channel.ChannelConfig;
|
|||
* @author Trustin Lee (tlee@redhat.com)
|
||||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public interface ServerSocketChannelConfig extends ChannelConfig {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ import org.jboss.netty.channel.Channel;
|
|||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.composedOf org.jboss.netty.channel.socket.SocketChannelConfig
|
||||
*/
|
||||
public interface SocketChannel extends Channel {
|
||||
|
|
|
|||
|
|
@ -58,8 +58,6 @@ import org.jboss.netty.channel.ChannelConfig;
|
|||
* @author Trustin Lee (tlee@redhat.com)
|
||||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public interface SocketChannelConfig extends ChannelConfig {
|
||||
|
||||
|
|
|
|||
|
|
@ -84,6 +84,8 @@ import org.jboss.netty.util.internal.ExecutorUtil;
|
|||
* @author Daniel Bevenius (dbevenius@jboss.com)
|
||||
*
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public class NioDatagramChannelFactory implements DatagramChannelFactory {
|
||||
|
||||
|
|
|
|||
|
|
@ -25,5 +25,7 @@
|
|||
* Abstract TCP and UDP socket interfaces which extend the core channel API.
|
||||
*
|
||||
* @apiviz.exclude \.(Abstract|Default).*$
|
||||
* @apiviz.exclude \.socket\.[a-z]+\.
|
||||
* @apiviz.exclude \.channel\.[A-Z]
|
||||
*/
|
||||
package org.jboss.netty.channel.socket;
|
||||
|
|
|
|||
|
|
@ -25,6 +25,6 @@
|
|||
* An alternative channel API implementation which uses
|
||||
* <a href="http://www.jboss.org/xnio/">JBoss XNIO</a> as its I/O provider.
|
||||
*
|
||||
* @apiviz.exclude \.(Abstract|Default).*$
|
||||
* @apiviz.exclude Channel$
|
||||
*/
|
||||
package org.jboss.netty.channel.xnio;
|
||||
|
|
|
|||
|
|
@ -54,6 +54,8 @@ import com.google.inject.Scopes;
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public class NettyModule extends AbstractModule {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.jboss.netty.buffer.HeapChannelBufferFactory;
|
|||
* @author Robert Harder (rob@iharder.net)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.base64.Base64Dialect
|
||||
*/
|
||||
public class Base64 {
|
||||
|
||||
|
|
|
|||
|
|
@ -53,6 +53,8 @@ import org.jboss.netty.handler.codec.oneone.OneToOneDecoder;
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.base64.Base64
|
||||
*/
|
||||
@ChannelPipelineCoverage("all")
|
||||
public class Base64Decoder extends OneToOneDecoder {
|
||||
|
|
|
|||
|
|
@ -47,6 +47,8 @@ import org.jboss.netty.handler.codec.oneone.OneToOneEncoder;
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.base64.Base64
|
||||
*/
|
||||
public class Base64Encoder extends OneToOneEncoder {
|
||||
|
||||
|
|
|
|||
|
|
@ -26,5 +26,7 @@
|
|||
* <a href="http://en.wikipedia.org/wiki/Base64">Base64</a>-encoded
|
||||
* {@link java.lang.String} or {@link org.jboss.netty.buffer.ChannelBuffer}
|
||||
* into a decoded {@link org.jboss.netty.buffer.ChannelBuffer} and vice versa.
|
||||
*
|
||||
* @apiviz.exclude OneToOne(Encoder|Decoder)$
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.base64;
|
||||
|
|
@ -66,8 +66,7 @@ import org.jboss.netty.channel.ChannelHandlerContext;
|
|||
*
|
||||
* @version $Rev:231 $, $Date:2008-06-12 16:44:50 +0900 (목, 12 6월 2008) $
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.frame.Delimiters - - optional yet useful
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.frame.Delimiters - - useful
|
||||
*/
|
||||
public class DelimiterBasedFrameDecoder extends FrameDecoder {
|
||||
|
||||
|
|
|
|||
|
|
@ -115,7 +115,6 @@ import org.jboss.netty.channel.ChannelHandlerContext;
|
|||
*
|
||||
* @version $Rev:231 $, $Date:2008-06-12 16:44:50 +0900 (목, 12 6월 2008) $
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @see LengthFieldPrepender
|
||||
*/
|
||||
public class LengthFieldBasedFrameDecoder extends FrameDecoder {
|
||||
|
|
|
|||
|
|
@ -25,5 +25,10 @@
|
|||
* Extensible decoder and its common implementations which deal with the
|
||||
* packet fragmentation and reassembly issue found in a stream-based transport
|
||||
* such as TCP/IP.
|
||||
*
|
||||
* @apiviz.exclude OneToOne(Encoder|Decoder)$
|
||||
* @apiviz.exclude \.(Simple)?Channel[A-Za-z]*Handler$
|
||||
* @apiviz.exclude \.codec\.serialization\.
|
||||
* @apiviz.exclude \.ssl\.
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.frame;
|
||||
|
|
@ -40,6 +40,9 @@ import java.util.regex.Pattern;
|
|||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
* @see CookieEncoder
|
||||
*
|
||||
* @apiviz.stereotype utility
|
||||
* @apiviz.has org.jboss.netty.handler.codec.http.Cookie oneway - - decodes
|
||||
*/
|
||||
public class CookieDecoder {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,9 @@ import java.util.TreeSet;
|
|||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
* @see CookieDecoder
|
||||
*
|
||||
* @apiviz.stereotype utility
|
||||
* @apiviz.has org.jboss.netty.handler.codec.http.Cookie oneway - - encodes
|
||||
*/
|
||||
public class CookieEncoder {
|
||||
|
||||
|
|
|
|||
|
|
@ -24,13 +24,21 @@ package org.jboss.netty.handler.codec.http;
|
|||
|
||||
import org.jboss.netty.buffer.ChannelBuffer;
|
||||
import org.jboss.netty.buffer.ChannelBuffers;
|
||||
import org.jboss.netty.channel.ChannelPipeline;
|
||||
|
||||
/**
|
||||
* An HTTP chunk which is used for HTTP chunked transfer-encoding.
|
||||
* {@link HttpMessageDecoder} generates {@link HttpChunk} after
|
||||
* {@link HttpMessage} when the content is large or the encoding of the content
|
||||
* is 'chunked. If you prefer not to receive {@link HttpChunk} in your handler,
|
||||
* please {@link HttpChunkAggregator} after {@link HttpMessageDecoder} in the
|
||||
* {@link ChannelPipeline}.
|
||||
*
|
||||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @see HttpChunkAggregator
|
||||
*/
|
||||
public interface HttpChunk {
|
||||
|
||||
|
|
|
|||
|
|
@ -54,6 +54,8 @@ import org.jboss.netty.handler.codec.frame.TooLongFrameException;
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.has org.jboss.netty.handler.codec.http.HttpChunk oneway - - filters out
|
||||
*/
|
||||
@ChannelPipelineCoverage("one")
|
||||
public class HttpChunkAggregator extends SimpleChannelUpstreamHandler {
|
||||
|
|
|
|||
|
|
@ -28,6 +28,8 @@ package org.jboss.netty.handler.codec.http;
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Andy Taylor (andy.taylor@jboss.org)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.stereotype static
|
||||
*/
|
||||
public final class HttpHeaders {
|
||||
|
||||
|
|
@ -37,6 +39,8 @@ public final class HttpHeaders {
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Andy Taylor (andy.taylor@jboss.org)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.stereotype static
|
||||
*/
|
||||
public static final class Names {
|
||||
/**
|
||||
|
|
@ -255,6 +259,8 @@ public final class HttpHeaders {
|
|||
* @author The Netty Project (netty-dev@lists.jboss.org)
|
||||
* @author Andy Taylor (andy.taylor@jboss.org)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.stereotype static
|
||||
*/
|
||||
public static final class Values {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -36,6 +36,9 @@ import org.jboss.netty.buffer.ChannelBuffers;
|
|||
* @author Andy Taylor (andy.taylor@jboss.org)
|
||||
* @author Trustin Lee (tlee@redhat.com)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.has org.jboss.netty.handler.codec.http.HttpChunk oneway - - is followed by
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.http.HttpHeaders - - useful
|
||||
*/
|
||||
public interface HttpMessage {
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,10 @@
|
|||
/**
|
||||
* Encoder, decoder and their related message types for HTTP.
|
||||
*
|
||||
* @apiviz.exclude \.HttpHeaders.*$
|
||||
* @apiviz.exclude \.QueryString.*$
|
||||
* @apiviz.exclude HttpHeaders\.
|
||||
* @apiviz.exclude ^java\.lang\.
|
||||
* @apiviz.exclude OneToOne(Encoder|Decoder)$
|
||||
* @apiviz.exclude \.codec\.replay\.
|
||||
* @apiviz.exclude \.(Simple)?Channel[A-Za-z]*Handler$
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.http;
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user