Tomcat 10.1.19 · org.apache.coyote.ajp.AjpMessage · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected final byte[]	buf Fixed size buffer.
protected int	len This actually means different things depending on whether the packet is read or write.
private static final Log	log
protected int	pos The current read or write position in the buffer.
protected static final StringManager	sm The string manager for this package.

Access	Constructor and Description
public	AjpMessage(int packetSize)

Method Summary

Modifier and Type	Method and Description
public void	appendByte(int The byte value to append val) Append a byte (1 byte) to the message.
public void	appendByteChunk(ByteChunk The data to write bc) Write a ByteChunk out at the current write position.
public void	appendBytes(MessageBytes The data to write mb) Write a MessageBytes out at the current write position.
public void	appendBytes(byte[] The array from which to copy bytes. b, int The offset into the array at which to start copying off, int The number of bytes to copy. numBytes) Copy a chunk of bytes into the packet, starting at the current write position.
public void	appendBytes(ByteBuffer The ByteBuffer from which to copy bytes. b) Copy a chunk of bytes into the packet, starting at the current write position.
public void	appendInt(int The integer to append val) Add a short integer (2 bytes) to the message.
private boolean	checkOverflow(int numBytes)
private void	doGetBytes(MessageBytes mb, boolean terminated)
private void	dump(String prefix)
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.
public void	getBodyBytes(MessageBytes mb)
public byte[]	Returns: The buffer getBuffer() Return the underlying byte buffer.
public byte	getByte()
public void	getBytes(MessageBytes mb)
public int	Returns: The integer value read from the message getInt() Read an integer from packet, and advance the read position past it.
public int	Returns: 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). getLen() Return the current message length.
public int	Returns: The long value read from the message getLongInt() Read a 32 bits integer from packet, and advance the read position past it.
protected static String	hex(int x)
protected static String	hexLine(byte[] buf, int start, int len)
public int	peekInt()
public int	processHeader(boolean toContainer)
public void	reset() Prepare this packet for accumulating a message from the container to the web server.
private void	validatePos(int posToTest)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buf	back to summary
protected final byte[] buf Fixed size buffer.

len	back to summary
protected int len 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.

log	back to summary
private static final Log log

pos	back to summary
protected int pos The current read or write position in the buffer.

sm	back to summary
protected static final StringManager sm The string manager for this package.

AjpMessage	back to summary
public AjpMessage(int packetSize)

Method Detail

appendByte	back to summary
public void appendByte(int val) Append a byte (1 byte) to the message. Parameters val:int The byte value to append

appendByte

back to summary

public void appendByte(int val)

Append a byte (1 byte) to the message.

Parameters

val:int: The byte value to append

appendByteChunk	back to summary
public void appendByteChunk(ByteChunk bc) Write a ByteChunk out at the current write position. A null ByteChunk is encoded as a string with length 0. Parameters bc:ByteChunk The data to write

appendByteChunk

back to summary

public void appendByteChunk(ByteChunk bc)

Write a ByteChunk out at the current write position. A null ByteChunk is encoded as a string with length 0.

Parameters

bc:ByteChunk: The data to write

appendBytes	back to summary
public void appendBytes(MessageBytes mb) Write a MessageBytes out at the current write position. A null MessageBytes is encoded as a string with length 0. Parameters mb:MessageBytes The data to write

appendBytes

back to summary

public void appendBytes(MessageBytes mb)

Write a MessageBytes out at the current write position. A null MessageBytes is encoded as a string with length 0.

Parameters

mb:MessageBytes: The data to write

appendBytes	back to summary
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:byte[] The array from which to copy bytes. off:int The offset into the array at which to start copying numBytes:int The number of bytes to copy.

appendBytes

back to summary

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:byte[]: The array from which to copy bytes.
off:int: The offset into the array at which to start copying
numBytes:int: The number of bytes to copy.

appendBytes	back to summary
public void appendBytes(ByteBuffer b) 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:ByteBuffer The ByteBuffer from which to copy bytes.

appendBytes

back to summary

public void appendBytes(ByteBuffer b)

Parameters

b:ByteBuffer: The ByteBuffer from which to copy bytes.

appendInt	back to summary
public void appendInt(int val) Add a short integer (2 bytes) to the message. Parameters val:int The integer to append

appendInt

back to summary

public void appendInt(int val)

Add a short integer (2 bytes) to the message.

Parameters

val:int: The integer to append

checkOverflow	back to summary
private boolean checkOverflow(int numBytes)

doGetBytes	back to summary
private void doGetBytes(MessageBytes mb, boolean terminated)

dump	back to summary
private void dump(String prefix)

end	back to summary
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.

getBodyBytes	back to summary
public void getBodyBytes(MessageBytes mb)

getBuffer	back to summary
public byte[] getBuffer() Return the underlying byte buffer. Returns:byte[] The buffer

getBuffer

back to summary

public byte[] getBuffer()

Return the underlying byte buffer.

Returns:byte[]: The buffer

getByte	back to summary
public byte getByte()

getBytes	back to summary
public void getBytes(MessageBytes mb)

getInt	back to summary
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. Returns:int The integer value read from the message

getInt

back to summary

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.

Returns:int: The integer value read from the message

getLen	back to summary
public int getLen() Return the current message length. Returns:int 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).

getLen

back to summary

public int getLen()

Return the current message length.

Returns:int: 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).

getLongInt	back to summary
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. Returns:int The long value read from the message

getLongInt

back to summary

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.

Returns:int: The long value read from the message

hex	back to summary
protected static String hex(int x)

hexLine	back to summary
protected static String hexLine(byte[] buf, int start, int len)

peekInt	back to summary
public int peekInt()

processHeader	back to summary
public int processHeader(boolean toContainer)

reset	back to summary
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).

validatePos	back to summary
private void validatePos(int posToTest)

public Class AjpMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail