* Updated APIviz tags
* More help on file transfer
This commit is contained in:
Trustin Lee
parent
ba08d11356
commit
66882ae708
2
pom.xml
2
pom.xml
@ -295,7 +295,7 @@
|
||||
<tasks>
|
||||
<mkdir dir="${project.build.directory}" />
|
||||
<echo message="${project.version}, r${buildNumber}" file="${project.build.directory}/version.txt" />
|
||||
<echo message="// DO NOT MODIFY - WILL BE OVERWRITTEN DURING THE BUILD PROCESS${line.separator}package org.jboss.netty.util;${line.separator}/** Provides the version information of Netty. */${line.separator}public final class Version {${line.separator} /** The version identifier. */${line.separator} public static final String ID = "${project.version}-r${buildNumber}";${line.separator} /** Prints out the version identifier to stdout. */${line.separator} public static void main(String[] args) { System.out.println(ID); }${line.separator} private Version() { super(); }${line.separator}}${line.separator}" file="${basedir}/src/main/java/org/jboss/netty/util/Version.java" />
|
||||
<echo message="// DO NOT MODIFY - WILL BE OVERWRITTEN DURING THE BUILD PROCESS${line.separator}package org.jboss.netty.util;${line.separator}/**${line.separator} * Provides the version information of Netty.${line.separator} * @apiviz.landmark${line.separator} */${line.separator}public final class Version {${line.separator} /** The version identifier. */${line.separator} public static final String ID = "${project.version}-r${buildNumber}";${line.separator} /** Prints out the version identifier to stdout. */${line.separator} public static void main(String[] args) { System.out.println(ID); }${line.separator} private Version() { super(); }${line.separator}}${line.separator}" file="${basedir}/src/main/java/org/jboss/netty/util/Version.java" />
|
||||
</tasks>
|
||||
</configuration>
|
||||
</execution>
|
||||
|
||||
@ -23,7 +23,7 @@ import org.jboss.netty.util.ExternalResourceReleasable;
|
||||
|
||||
/**
|
||||
* A region of a file that is sent via a {@link Channel} which supports
|
||||
* zero-copy file transfer.
|
||||
* <a href="http://en.wikipedia.org/wiki/Zero-copy">zero-copy file transfer</a>.
|
||||
*
|
||||
* <h3>Upgrade your JDK / JRE</h3>
|
||||
*
|
||||
@ -42,6 +42,12 @@ import org.jboss.netty.util.ExternalResourceReleasable;
|
||||
* - FileChannel.transferTo(2147483647, 1, channel) causes "Value too large" exception</li>
|
||||
* </ul>
|
||||
*
|
||||
* <h3>Check your operating system and JDK / JRE</h3>
|
||||
*
|
||||
* If your operating system (or JDK / JRE) does not support zero-copy file
|
||||
* transfer, sending a file with {@link FileRegion} might fail or yield worse
|
||||
* performance. For example, sending a large file doesn't work well in Windows.
|
||||
*
|
||||
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
|
||||
|
||||
@ -30,6 +30,7 @@ import java.util.TreeSet;
|
||||
* @author Andy Taylor (andy.taylor@jboss.org)
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.stereotype static
|
||||
*/
|
||||
public class HttpHeaders {
|
||||
|
||||
@ -33,6 +33,9 @@ import org.jboss.netty.handler.codec.replay.VoidEnum;
|
||||
* @author Mike Heath (mheath@apache.org)
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.http.websocket.WebSocketFrame
|
||||
*/
|
||||
public class WebSocketFrameDecoder extends ReplayingDecoder<VoidEnum> {
|
||||
|
||||
|
||||
@ -32,6 +32,9 @@ import org.jboss.netty.handler.codec.oneone.OneToOneEncoder;
|
||||
* @author Mike Heath (mheath@apache.org)
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
* @apiviz.uses org.jboss.netty.handler.codec.http.websocket.WebSocketFrame
|
||||
*/
|
||||
@Sharable
|
||||
public class WebSocketFrameEncoder extends OneToOneEncoder {
|
||||
|
||||
@ -24,5 +24,6 @@
|
||||
* *
|
||||
* @apiviz.exclude OneToOne(Encoder|Decoder)$
|
||||
* @apiviz.exclude \.codec\.replay\.
|
||||
* @apiviz.exclude \.Default
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.http.websocket;
|
||||
|
||||
@ -21,5 +21,6 @@
|
||||
* and vice versa.
|
||||
*
|
||||
* @apiviz.exclude \.oneone\.
|
||||
* @apiviz.exclude \.frame\.
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.protobuf;
|
||||
|
||||
@ -25,6 +25,9 @@ import org.jboss.netty.handler.codec.http.HttpHeaders;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.exclude
|
||||
* @apiviz.stereotype static
|
||||
*/
|
||||
public final class RtspHeaders {
|
||||
|
||||
@ -220,7 +223,7 @@ public final class RtspHeaders {
|
||||
}
|
||||
|
||||
/**
|
||||
* Standard RTSP header names.
|
||||
* Standard RTSP header values.
|
||||
*
|
||||
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
|
||||
@ -56,6 +56,8 @@ import org.jboss.netty.handler.codec.http.HttpMessageDecoder;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public abstract class RtspMessageDecoder extends HttpMessageDecoder {
|
||||
|
||||
|
||||
@ -30,6 +30,8 @@ import org.jboss.netty.handler.codec.http.HttpMessageEncoder;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
@Sharable
|
||||
public abstract class RtspMessageEncoder extends HttpMessageEncoder {
|
||||
|
||||
@ -27,6 +27,8 @@ import org.jboss.netty.handler.codec.http.HttpMethod;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.exclude
|
||||
*/
|
||||
public final class RtspMethods {
|
||||
|
||||
|
||||
@ -24,6 +24,8 @@ import org.jboss.netty.handler.codec.http.HttpResponseStatus;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.exclude
|
||||
*/
|
||||
public final class RtspResponseStatuses {
|
||||
|
||||
|
||||
@ -24,6 +24,8 @@ import org.jboss.netty.handler.codec.http.HttpVersion;
|
||||
* @author <a href="http://amitbhayani.blogspot.com/">Amit Bhayani</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.exclude
|
||||
*/
|
||||
public final class RtspVersions {
|
||||
|
||||
|
||||
@ -17,5 +17,7 @@
|
||||
/**
|
||||
* An <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a>
|
||||
* extension based on the HTTP codec.
|
||||
*
|
||||
* @apiviz.exclude \.RtspHeaders\.
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.rtsp;
|
||||
|
||||
@ -21,6 +21,5 @@
|
||||
*
|
||||
* @apiviz.exclude ^java\.io\.
|
||||
* @apiviz.exclude \.codec\.(?!serialization)[a-z0-9]+\.
|
||||
* @apiviz.exclude \.CompatibleObjectDecoder$
|
||||
*/
|
||||
package org.jboss.netty.handler.codec.serialization;
|
||||
|
||||
@ -37,7 +37,7 @@ import org.jboss.netty.util.internal.LinkedTransferQueue;
|
||||
|
||||
/**
|
||||
* Emulates buffered write operation. This handler stores all write requests
|
||||
* into an unbounded {@link Queue} and flushed them to the downstream when
|
||||
* into an unbounded {@link Queue} and flushes them to the downstream when
|
||||
* {@link #flush()} method is called.
|
||||
* <p>
|
||||
* Here is an example that demonstrates the usage:
|
||||
@ -158,6 +158,8 @@ import org.jboss.netty.util.internal.LinkedTransferQueue;
|
||||
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
* @version $Rev$, $Date$
|
||||
*
|
||||
* @apiviz.landmark
|
||||
*/
|
||||
public class BufferedWriteHandler extends SimpleChannelHandler {
|
||||
|
||||
|
||||
@ -17,5 +17,8 @@
|
||||
/**
|
||||
* The special-purpose handlers that store an event into an internal queue
|
||||
* instead of propagating the event immediately.
|
||||
*
|
||||
* @apiviz.exclude \.channel\.
|
||||
* @apiviz.exclude Exception$
|
||||
*/
|
||||
package org.jboss.netty.handler.queue;
|
||||
|
||||
@ -21,8 +21,14 @@ import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.RandomAccessFile;
|
||||
|
||||
import org.jboss.netty.channel.FileRegion;
|
||||
|
||||
/**
|
||||
* A {@link ChunkedInput} that fetches data from a file chunk by chunk.
|
||||
* <p>
|
||||
* If your operating system supports
|
||||
* <a href="http://en.wikipedia.org/wiki/Zero-copy">zero-copy file transfer</a>
|
||||
* such as {@code sendfile()}, you might want to use {@link FileRegion} instead.
|
||||
*
|
||||
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
|
||||
@ -23,9 +23,15 @@ import java.io.IOException;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.channels.FileChannel;
|
||||
|
||||
import org.jboss.netty.channel.FileRegion;
|
||||
|
||||
/**
|
||||
* A {@link ChunkedInput} that fetches data from a file chunk by chunk using
|
||||
* NIO {@link FileChannel}.
|
||||
* <p>
|
||||
* If your operating system supports
|
||||
* <a href="http://en.wikipedia.org/wiki/Zero-copy">zero-copy file transfer</a>
|
||||
* such as {@code sendfile()}, you might want to use {@link FileRegion} instead.
|
||||
*
|
||||
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
||||
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user