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.
| Method from org.apache.jk.common.MsgAjp Detail: |
public void appendByte(int val) {
buf[pos++] = (byte)val;
}
|
public void appendByteChunk(ByteChunk bc) throws IOException {
if(bc==null) {
log.error("appendByteChunk() null");
appendInt( 0);
appendByte(0);
return;
}
byte[] bytes = bc.getBytes();
int start=bc.getStart();
int length = bc.getLength();
appendInt( length );
cpBytes(bytes, start, length);
appendByte(0);
}
|
public void appendBytes(MessageBytes mb) throws IOException {
if(mb==null || mb.isNull() ) {
appendInt( 0);
appendByte(0);
return;
}
// XXX Convert !!
ByteChunk bc= mb.getByteChunk();
appendByteChunk(bc);
}
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. |
public void appendBytes(byte[] b,
int off,
int numBytes) {
appendInt( numBytes );
cpBytes( b, off, numBytes );
appendByte(0);
}
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). |
public void appendInt(int val) {
buf[pos++] = (byte) ((val > > > 8) & 0xFF);
buf[pos++] = (byte) (val & 0xFF);
}
|
public void appendLongInt(int val) {
buf[pos++] = (byte) ((val > > > 24) & 0xFF);
buf[pos++] = (byte) ((val > > > 16) & 0xFF);
buf[pos++] = (byte) ((val > > > 8) & 0xFF);
buf[pos++] = (byte) (val & 0xFF);
}
|
public void dump(String msg) {
if( log.isDebugEnabled() )
log.debug( msg + ": " + buf + " " + pos +"/" + (len + 4));
int max=pos;
if( len + 4 > pos )
max=len+4;
if( max >1000 ) max=1000;
if( log.isDebugEnabled() )
for( int j=0; j < max; j+=16 )
log.debug( hexLine( buf, j, len ));
}
|
public void end() {
len=pos;
int dLen=len-4;
buf[0] = (byte)0x41;
buf[1] = (byte)0x42;
buf[2]= (byte)((dLen > > >8 ) & 0xFF );
buf[3] = (byte)(dLen & 0xFF);
}
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. |
public byte[] getBuffer() {
return buf;
}
|
public byte getByte() {
byte res = buf[pos++];
return res;
}
|
public void getBytes(MessageBytes mb) {
int length = getInt();
if( (length == 0xFFFF) || (length == -1) ) {
mb.recycle();
return;
}
mb.setBytes( buf, pos, length );
mb.getCharChunk().recycle();
pos += length;
pos++; // Skip the terminating \0
}
|
public int getBytes(byte[] dest) {
int length = getInt();
if( length > buf.length ) {
// XXX Should be if(pos + length > buff.legth)?
log.error("getBytes() buffer overflow " + length + " " + buf.length );
}
if( (length == 0xFFFF) || (length == -1) ) {
log.info("Null string " + length);
return 0;
}
System.arraycopy( buf, pos, dest, 0, length );
pos += length;
pos++; // Skip terminating \0 XXX I believe this is wrong but harmless
return length;
}
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. |
public int getHeaderLength() {
return 4;
}
|
public int getInt() {
int b1 = buf[pos++] & 0xFF; // No swap, Java order
int b2 = buf[pos++] & 0xFF;
return (b1< < 8) + b2;
}
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. |
public int getLen() {
return len;
}
|
public int getLongInt() {
int b1 = buf[pos++] & 0xFF; // No swap, Java order
b1 < < = 8;
b1 |= (buf[pos++] & 0xFF);
b1 < < = 8;
b1 |= (buf[pos++] & 0xFF);
b1 < < =8;
b1 |= (buf[pos++] & 0xFF);
return b1;
}
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. |
public static String hexLine(byte[] buf,
int start,
int len) {
StringBuffer sb=new StringBuffer();
for( int i=start; i< start+16 ; i++ ) {
if( i < len + 4)
sb.append( hex( buf[i] ) + " ");
else
sb.append( " " );
}
sb.append(" | ");
for( int i=start; i < start+16 && i < len + 4; i++ ) {
if( ! Character.isISOControl( (char)buf[i] ))
sb.append( new Character((char)buf[i]) );
else
sb.append( "." );
}
return sb.toString();
}
|
public byte peekByte() {
byte res = buf[pos];
return res;
}
|
public int peekInt() {
int b1 = buf[pos] & 0xFF; // No swap, Java order
int b2 = buf[pos+1] & 0xFF;
return (b1< < 8) + b2;
}
|
public int processHeader() {
pos = 0;
int mark = getInt();
len = getInt();
if( mark != 0x1234 && mark != 0x4142 ) {
// XXX Logging
log.error("BAD packet signature " + mark);
dump( "In: " );
return -1;
}
if( log.isDebugEnabled() )
log.debug( "Received " + len + " " + buf[0] );
return len;
}
|
public void reset() {
len = 4;
pos = 4;
}
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). |