org.apache.ajp
Class Ajp13Packet
java.lang.Object
org.apache.ajp.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.
- Henri Gomez [hgomez@apache.org]
- Dan Milstein [danmil@shore.net]
- Keith Wannamaker [Keith@Wannamaker.org]
- Kevin Seguin
- Costin Manolache
Ajp14/Ajp13Packet
Ajp13Packet(b[] ) - Create a new packet with given bytes
|
Ajp13Packet(int size) - Create a new packet with an internal buffer of given size.
|
MessageBytes | addHeader(MimeHeaders headers)
|
void | appendBool(boolean val)
|
void | appendByte(byte val)
|
void | appendBytes(b[] , int off, int numBytes) - Copy a chunk of bytes into the packet, starting at the current
write position.
|
void | appendInt(int val)
|
void | appendLongInt(int val)
|
void | appendString(String str) - Write a String out at the current write position.
|
void | appendXBytes(byte[] b, int off, int numBytes) - Copy a chunk of bytes into the packet, starting at the current
write position.
|
int | checkIn() - Parse the packet header for a packet sent from the web server to
the container.
|
void | dump(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() - Get the internal buffer
|
byte | getByte()
|
int | getByteOff() - Get offset into internal buffer.
|
int | getBytes(dest[] ) - Copy a chunk of bytes from the packet into an array and advance
the read position past the chunk.
|
String | getEncoding() - Get the encoding used for byte[] <-> string
conversions.
|
int | getInt() - Read an integer from packet, and advance the read position past
it.
|
int | getLen() - Get length.
|
int | getLongInt() - Read a 32 bits integer from packet, and advance the read position past
it.
|
void | getMessageBytes(MessageBytes mb)
|
String | getString() - Read a String from the packet, and advance the read position
past it.
|
int | getXBytes(byte[] dest, int length) - Copy a chunk of bytes from the packet into an array and advance
the read position past the chunk.
|
byte | peekByte()
|
int | peekInt() - Read an integer from the packet, but don't advance the read
position past it.
|
int | peekLongInt() - Read a 32 bits 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) - Set offset into internal buffer.
|
void | setEncoding(String encoding) - Set the encoding to use for byte[] <-> string
conversions.
|
AJP13_SW_HEADER
public static final int AJP13_SW_HEADER
- 16706
AJP13_WS_HEADER
public static final int AJP13_WS_HEADER
- 4660
DEFAULT_CHAR_ENCODING
public static final String DEFAULT_CHAR_ENCODING
Ajp13Packet
public Ajp13Packet(b[] )
Create a new packet with given bytes
Ajp13Packet
public Ajp13Packet(int size)
Create a new packet with an internal buffer of given size.
size
- packet size
appendBool
public void appendBool(boolean val)
appendByte
public void appendByte(byte val)
appendBytes
public void appendBytes(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).
off
- The offset into the array at which to start copying
appendInt
public void appendInt(int val)
appendLongInt
public void appendLongInt(int val)
appendString
public void appendString(String str)
throws UnsupportedEncodingException
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.
appendXBytes
public void appendXBytes(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 NOT ENCODED with ANY length
header.
b
- The array from which to copy bytes.off
- The offset into the array at which to start copying
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.
- The length of the packet payload, as encoded in the
header, or -1 if the packet doesn't have a valid header.
dump
public void dump(String msg)
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.
getBool
public boolean getBool()
getBuff
public byte[] getBuff()
Get the internal buffer
- internal buffer
getByte
public byte getByte()
getByteOff
public int getByteOff()
Get offset into internal buffer.
- offset
getBytes
public int getBytes(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.
- The number of bytes copied.
getEncoding
public String getEncoding()
Get the encoding used for byte[] <-> string
conversions.
- the encoding used.
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.
getLen
public int getLen()
Get length.
- length -- This actually means different things depending on whether the
packet is read or write. For read, it's the length of the
payload (excluding the header). For write, it's the length of
the packet as a whole (counting the header). Oh, well.
getLongInt
public int getLongInt()
Read a 32 bits integer from packet, and advance the read position past
it. Integers are encoded as four unsigned bytes with the
high-order byte first, and, as far as I can tell, in
little-endian order within each byte.
getString
public 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.
getXBytes
public int getXBytes(byte[] dest,
int length)
Copy a chunk of bytes from the packet into an array and advance
the read position past the chunk. See appendXBytes() for details
on the encoding.
- The number of bytes copied.
peekByte
public byte peekByte()
peekInt
public int peekInt()
Read an integer from the packet, but don't advance the read
position past it.
peekLongInt
public int peekLongInt()
Read a 32 bits integer from the packet, but don't advance the read
position past it.
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).
setByteOff
public void setByteOff(int c)
Set offset into internal buffer.
c
- new offset
setEncoding
public void setEncoding(String encoding)
Set the encoding to use for byte[] <-> string
conversions.
encoding
- the encoding to use.
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.