org.apache.tomcat.modules.server
Class Ajp13Packet

java.lang.Object
  extended byorg.apache.tomcat.modules.server.Ajp13Packet

public class Ajp13Packet
extends java.lang.Object

A single packet for communication between the web server and the container. Designed to be reused many times with no creation of garbage. Understands the format of data types for these packets. Can be used (somewhat confusingly) for both incoming and outgoing packets.

Author:
Dan Milstein [danmil@shore.net], Keith Wannamaker [Keith@Wannamaker.org]

Field Summary
static java.lang.String DEFAULT_CHAR_ENCODING
           
 
Constructor Summary
Ajp13Packet(byte[] b)
           
Ajp13Packet(int size)
          Create a new packet with an internal buffer of given size.
Ajp13Packet(OutputBuffer ob)
           
 
Method Summary
 MessageBytes addHeader(MimeHeaders headers)
           
 void appendBool(boolean val)
           
 void appendByte(byte val)
           
 void appendBytes(byte[] b, int off, int numBytes)
          Copy a chunk of bytes into the packet, starting at the current write position.
 void appendInt(int val)
           
 void appendString(java.lang.String str)
          Write a String out at the current write position.
 int checkIn()
          Parse the packet header for a packet sent from the web server to the container.
 void dump(java.lang.String msg)
           
 void end()
          For a packet to be sent to the web server, finish the process of accumulating data and write the length of the data payload into the header.
 boolean getBool()
           
 byte[] getBuff()
           
 byte getByte()
           
 int getByteOff()
           
 int getBytes(byte[] dest)
          Copy a chunk of bytes from the packet into an array and advance the read position past the chunk.
 int getInt()
          Read an integer from packet, and advance the read position past it.
 int getLen()
           
 void getMessageBytes(MessageBytes mb)
           
 java.lang.String getString()
          Read a String from the packet, and advance the read position past it.
 byte peekByte()
           
 int peekInt()
          Read an integer from the packet, but don't advance the read position past it.
 void reset()
          Prepare this packet for accumulating a message from the container to the web server.
 void setByteOff(int c)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_CHAR_ENCODING

public static final java.lang.String DEFAULT_CHAR_ENCODING
See Also:
Constant Field Values
Constructor Detail

Ajp13Packet

public Ajp13Packet(int size)
Create a new packet with an internal buffer of given size.


Ajp13Packet

public Ajp13Packet(byte[] b)

Ajp13Packet

public Ajp13Packet(OutputBuffer ob)
Method Detail

getBuff

public byte[] getBuff()

getLen

public int getLen()

getByteOff

public int getByteOff()

setByteOff

public void setByteOff(int c)

checkIn

public int checkIn()
Parse the packet header for a packet sent from the web server to the container. Set the read position to immediately after the header.

Returns:
The length of the packet payload, as encoded in the header, or -1 if the packet doesn't have a valid header.

reset

public void reset()
Prepare this packet for accumulating a message from the container to the web server. Set the write position to just after the header (but leave the length unwritten, because it is as yet unknown).


end

public void end()
For a packet to be sent to the web server, finish the process of accumulating data and write the length of the data payload into the header.


appendInt

public void appendInt(int val)

appendByte

public void appendByte(byte val)

appendBool

public void appendBool(boolean val)

appendString

public void appendString(java.lang.String str)
Write a String out at the current write position. Strings are encoded with the length in two bytes first, then the string, and then a terminating \0 (which is not included in the encoded length). The terminator is for the convenience of the C code, where it saves a round of copying. A null string is encoded as a string with length 0.


appendBytes

public void appendBytes(byte[] b,
                        int off,
                        int numBytes)
Copy a chunk of bytes into the packet, starting at the current write position. The chunk of bytes is encoded with the length in two bytes first, then the data itself, and finally a terminating \0 (which is not included in the encoded length).

Parameters:
b - The array from which to copy bytes.
off - The offset into the array at which to start copying

getInt

public int getInt()
Read an integer from packet, and advance the read position past it. Integers are encoded as two unsigned bytes with the high-order byte first, and, as far as I can tell, in little-endian order within each byte.


peekInt

public int peekInt()
Read an integer from the packet, but don't advance the read position past it.


getByte

public byte getByte()

peekByte

public byte peekByte()

getBool

public boolean getBool()

getMessageBytes

public void getMessageBytes(MessageBytes mb)

addHeader

public MessageBytes addHeader(MimeHeaders headers)

getString

public java.lang.String getString()
                           throws java.io.UnsupportedEncodingException
Read a String from the packet, and advance the read position past it. See appendString for details on string encoding.

Throws:
java.io.UnsupportedEncodingException

getBytes

public int getBytes(byte[] dest)
Copy a chunk of bytes from the packet into an array and advance the read position past the chunk. See appendBytes() for details on the encoding.

Returns:
The number of bytes copied.

dump

public void dump(java.lang.String msg)


Copyright ? 2001 Apache Software Foundation. All Rights Reserved.