org.apache.jk.common

Class MsgAjp

public class MsgAjp extends Msg

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. See Ajp14/Ajp13Packet.java.

Author: Henri Gomez [hgomez@apache.org] Dan Milstein [danmil@shore.net] Keith Wannamaker [Keith@Wannamaker.org] Kevin Seguin Costin Manolache

Constructor Summary
MsgAjp(int bsize)
Constructor that takes a buffer size
MsgAjp()
No arg constructor.
Method Summary
voidappendByte(int val)
voidappendByteChunk(ByteChunk bc)
voidappendBytes(MessageBytes mb)
Write a String out at the current write position.
voidappendBytes(byte[] b, int off, int numBytes)
Copy a chunk of bytes into the packet, starting at the current write position.
voidappendInt(int val)
Add an int.
voidappendLongInt(int val)
voiddump(String msg)
voidend()
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.
byte[]getBuffer()
bytegetByte()
voidgetBytes(MessageBytes mb)
intgetBytes(byte[] dest)
Copy a chunk of bytes from the packet into an array and advance the read position past the chunk.
intgetHeaderLength()
intgetInt()
Read an integer from packet, and advance the read position past it.
intgetLen()
intgetLongInt()
Read a 32 bits integer from packet, and advance the read position past it.
static StringhexLine(byte[] buf, int start, int len)
bytepeekByte()
intpeekInt()
intprocessHeader()
voidreset()
Prepare this packet for accumulating a message from the container to the web server.

Constructor Detail

MsgAjp

public MsgAjp(int bsize)
Constructor that takes a buffer size

MsgAjp

public MsgAjp()

Deprecated: Use the buffer size constructor.

No arg constructor.

Method Detail

appendByte

public void appendByte(int val)

appendByteChunk

public void appendByteChunk(ByteChunk bc)

appendBytes

public void appendBytes(MessageBytes mb)
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 numBytes The number of bytes to copy.

appendInt

public void appendInt(int val)
Add an int.

Parameters: val The integer to write.

appendLongInt

public void appendLongInt(int val)

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.

getBuffer

public byte[] getBuffer()

getByte

public byte getByte()

getBytes

public void getBytes(MessageBytes mb)

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.

getHeaderLength

public int getHeaderLength()

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()

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.

hexLine

public static String hexLine(byte[] buf, int start, int len)

peekByte

public byte peekByte()

peekInt

public int peekInt()

processHeader

public int processHeader()

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).
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.