inspectorj - Java(TM) Profiler

ClientPacketHandler handles reading and writing packets to the socket and dispatching incoming replies to the correct actions.

The JDWP protocol is stateless and asynchronous. Therefore commands and replies must be paired by using a common id. ClientPacketHandler manages this by storing one or more callback actions when sending a command. The callbacks are mapped to the command's id. When a reply is received, any callback actions that are mapped to the reply's id are retreived and triggered. The reply packet is passed as a parameter to the callback action's trigger function.

Definition at line 63 of file clientpackethandler.h.


Public Member Functions
	ClientPacketHandler (QTcpSocket &)
	Constructor.
void	readJDWPPacket ()
	Read a packet from the profiler server.
void	sendJDWPCommand (JDWPCommand , QList< JDWPAction > &)
	Send a command to the profiler server.
void	getHandshake (bool &attached, QString &msg)
	Get the handshake response from the profiler server.
void	getSocketError (QAbstractSocket::SocketError error, QString &errMsg)
	Get an error message describing the SocketError.
Static Public Member Functions
static void	getJDWPError (int errCode, QString &s)
	Evaluate the errorCode returned by a jdwpReplyPacket.
static bool	handleJDWPError (JDWPPacket &packet)
	Handle errors, if any, returned by jdwpReplyPackets.
Private Slots
void	initIdSizes (JDWPPacket &)
	Initialize the static id sizes after we are connected.
Private Member Functions
void	operator>> (QString &s)
	Reads string data from the socket.
void	handleResponse (JDWPPacket &)
	Retrieve the Callback actions that are mapped to the id of the JDWPPacket.
Private Attributes
JDWPAction *	initIdSizesAction
	JDWPAction to initialize the JDWP ID sizes when attached.
QMultiMap< int, JDWPAction * >	replyCallbackMap
	A map that holds the callback actions.
QTcpSocket &	tcpSocket
	The socket used to communicate with the profiler server.
quint32	packetSize
	The size of the incoming packet.

Constructor & Destructor Documentation

ClientPacketHandler::ClientPacketHandler ( QTcpSocket & socket )

Constructor.

Parameters:

socket

The QTcpSocket used for the connection to the profiler server.

Definition at line 39 of file clientpackethandler.cpp.

References initIdSizes(), and initIdSizesAction.

Member Function Documentation

void ClientPacketHandler::readJDWPPacket ( )

Read a packet from the profiler server.

The packet may be a jdwpReplyPacket or a jdwpCmdPacket. After reading the complete packet, the packet will be passed to handleResponse(JDWPPacket).

Definition at line 85 of file clientpackethandler.cpp.

References handleResponse(), inspectorj::jdwp::JDWP_HEADER_LENGTH, packetSize, and tcpSocket.

Referenced by inspectorj::client::ConnectionManager::readPacket().

void ClientPacketHandler::sendJDWPCommand	(	JDWPCommand *	cmd,
		QList< JDWPAction * > &	actions
	)

Send a command to the profiler server.

The CallbackFunctor(s) are stored and mapped to the command's id so they can be invoked when a jdwpReplyPacket is received from the server that has a matching id.

Parameters:

	cmd	The JDWPCommand to be sent
	actions	The list of actions to be invoked when a reply to this command is received.

Definition at line 55 of file clientpackethandler.cpp.

References inspectorj::jdwp::JDWPCommand::getCmd(), inspectorj::jdwp::JDWPCommand::getCmdSet(), inspectorj::jdwp::JDWPPacket::getDataBytes(), inspectorj::jdwp::JDWPCommand::getId(), inspectorj::jdwp::JDWPPacket::getLength(), inspectorj::jdwp::JDWPCommand::getPacketType(), inspectorj::jdwp::JDWP_HEADER_LENGTH, replyCallbackMap, and tcpSocket.

Referenced by getHandshake(), and inspectorj::client::ConnectionManager::sendRequest().

void ClientPacketHandler::getHandshake	(	bool &	attached,
		QString &	msg
	)

Get the handshake response from the profiler server.

This function is called when there is incoming data to read and we are not yet attached to the server. Note: attached and connected are different in this context. Connected means that we've established a TCP connection. Attached means we've successfully performed a handshake with the server.

Definition at line 180 of file clientpackethandler.cpp.

References initIdSizesAction, inspectorj::jdwp::JDWP_HANDSHAKE, inspectorj::jdwp::JDWP_HANDSHAKE_LENGTH, sendJDWPCommand(), and tcpSocket.

Referenced by inspectorj::client::ConnectionManager::receiveHandshake().