refactor(network): add getByteCount() to all 25 command message classes for consistent polymorphic interface

Author: bobtista

GeneralsMD/Code/GameEngine/Include/GameNetwork/NetCommandMsg.h

@@ -110,6 +110,8 @@ class NetAckBothCommandMsg : public NetCommandMsg
 	UnsignedByte getOriginalPlayerID();
 	void setOriginalPlayerID(UnsignedByte originalPlayerID);
 	virtual Int getSortNumber();
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_commandID;
@@ -134,6 +136,8 @@ class NetAckStage1CommandMsg : public NetCommandMsg
 	UnsignedByte getOriginalPlayerID();
 	void setOriginalPlayerID(UnsignedByte originalPlayerID);
 	virtual Int getSortNumber();
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_commandID;
@@ -158,6 +162,8 @@ class NetAckStage2CommandMsg : public NetCommandMsg
 	UnsignedByte getOriginalPlayerID();
 	void setOriginalPlayerID(UnsignedByte originalPlayerID);
 	virtual Int getSortNumber();
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_commandID;
@@ -174,6 +180,8 @@ class NetFrameCommandMsg : public NetCommandMsg
 
 	void setCommandCount(UnsignedShort commandCount);
 	UnsignedShort getCommandCount();
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_commandCount;
@@ -189,6 +197,8 @@ class NetPlayerLeaveCommandMsg : public NetCommandMsg
 
 	UnsignedByte getLeavingPlayerID();
 	void setLeavingPlayerID(UnsignedByte id);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedByte m_leavingPlayerID;
@@ -206,6 +216,8 @@ class NetRunAheadMetricsCommandMsg : public NetCommandMsg
 	void setAverageLatency(Real avgLat);
 	Int  getAverageFps();
 	void setAverageFps(Int fps);
+	
+	size_t getByteCount() const;
 
 protected:
 	Real m_averageLatency;
@@ -225,6 +237,8 @@ class NetRunAheadCommandMsg : public NetCommandMsg
 
 	UnsignedByte getFrameRate();
 	void setFrameRate(UnsignedByte frameRate);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_runAhead;
@@ -241,6 +255,8 @@ class NetDestroyPlayerCommandMsg : public NetCommandMsg
 
 	UnsignedInt getPlayerIndex();
 	void setPlayerIndex(UnsignedInt playerIndex);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedInt m_playerIndex;
@@ -253,6 +269,8 @@ class NetKeepAliveCommandMsg : public NetCommandMsg
 public:
 	NetKeepAliveCommandMsg();
 	//virtual ~NetKeepAliveCommandMsg();
+	
+	size_t getByteCount() const;
 };
 
 //-----------------------------------------------------------------------------
@@ -262,6 +280,8 @@ class NetDisconnectKeepAliveCommandMsg : public NetCommandMsg
 public:
 	NetDisconnectKeepAliveCommandMsg();
 	//virtual ~NetDisconnectKeepAliveCommandMsg();
+	
+	size_t getByteCount() const;
 };
 
 //-----------------------------------------------------------------------------
@@ -277,6 +297,8 @@ class NetDisconnectPlayerCommandMsg : public NetCommandMsg
 
 	UnsignedInt getDisconnectFrame();
 	void setDisconnectFrame(UnsignedInt frame);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedByte m_disconnectSlot;
@@ -290,6 +312,8 @@ class NetPacketRouterQueryCommandMsg : public NetCommandMsg
 public:
 	NetPacketRouterQueryCommandMsg();
 	//virtual ~NetPacketRouterQueryCommandMsg();
+	
+	size_t getByteCount() const;
 };
 
 //-----------------------------------------------------------------------------
@@ -299,6 +323,8 @@ class NetPacketRouterAckCommandMsg : public NetCommandMsg
 public:
 	NetPacketRouterAckCommandMsg();
 	//virtual ~NetPacketRouterAckCommandMsg();
+	
+	size_t getByteCount() const;
 };
 
 //-----------------------------------------------------------------------------
@@ -352,6 +378,8 @@ class NetDisconnectVoteCommandMsg : public NetCommandMsg
 
 	UnsignedInt getVoteFrame();
 	void setVoteFrame(UnsignedInt voteFrame);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedByte m_slot;
@@ -368,6 +396,8 @@ class NetProgressCommandMsg: public NetCommandMsg
 
 	UnsignedByte getPercentage();
 	void setPercentage( UnsignedByte percent );
+	
+	size_t getByteCount() const;
 protected:
 	UnsignedByte m_percent;
 };
@@ -382,6 +412,8 @@ class NetWrapperCommandMsg : public NetCommandMsg
 
 	UnsignedByte * getData();
 	void setData(UnsignedByte *data, UnsignedInt dataLength);
+	
+	size_t getByteCount() const;
 
 	UnsignedInt getChunkNumber();
 	void setChunkNumber(UnsignedInt chunkNumber);
@@ -480,6 +512,8 @@ class NetFileProgressCommandMsg : public NetCommandMsg
 
 	Int getProgress();
 	void setProgress(Int val);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedShort m_fileID;
@@ -495,6 +529,8 @@ class NetDisconnectFrameCommandMsg : public NetCommandMsg
 
 	UnsignedInt getDisconnectFrame();
 	void setDisconnectFrame(UnsignedInt disconnectFrame);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedInt m_disconnectFrame;
@@ -509,6 +545,8 @@ class NetDisconnectScreenOffCommandMsg : public NetCommandMsg
 
 	UnsignedInt getNewFrame();
 	void setNewFrame(UnsignedInt newFrame);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedInt m_newFrame;
@@ -523,6 +561,8 @@ class NetFrameResendRequestCommandMsg : public NetCommandMsg
 
 	UnsignedInt getFrameToResend();
 	void setFrameToResend(UnsignedInt frame);
+	
+	size_t getByteCount() const;
 
 protected:
 	UnsignedInt m_frameToResend;

GeneralsMD/Code/GameEngine/Source/GameNetwork/NetCommandMsg.cpp

@@ -1173,3 +1173,87 @@ UnsignedInt NetFrameResendRequestCommandMsg::getFrameToResend() {
 void NetFrameResendRequestCommandMsg::setFrameToResend(UnsignedInt frame) {
 	m_frameToResend = frame;
 }
+
+//-------------------------
+// getByteCount() implementations for fixed-size command messages
+//-------------------------
+
+size_t NetAckBothCommandMsg::getByteCount() const {
+	return sizeof(NetPacketAckCommand);
+}
+
+size_t NetFrameCommandMsg::getByteCount() const {
+	return sizeof(NetPacketFrameCommand);
+}
+
+size_t NetKeepAliveCommandMsg::getByteCount() const {
+	return sizeof(NetPacketKeepAliveCommand);
+}
+
+size_t NetWrapperCommandMsg::getByteCount() const {
+	return sizeof(NetPacketWrapperCommand);
+}
+
+size_t NetAckStage1CommandMsg::getByteCount() const {
+	return sizeof(NetPacketAckCommand);
+}
+
+size_t NetAckStage2CommandMsg::getByteCount() const {
+	return sizeof(NetPacketAckCommand);
+}
+
+size_t NetPlayerLeaveCommandMsg::getByteCount() const {
+	return sizeof(NetPacketPlayerLeaveCommand);
+}
+
+size_t NetRunAheadMetricsCommandMsg::getByteCount() const {
+	return sizeof(NetPacketRunAheadMetricsCommand);
+}
+
+size_t NetRunAheadCommandMsg::getByteCount() const {
+	return sizeof(NetPacketRunAheadCommand);
+}
+
+size_t NetDestroyPlayerCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDestroyPlayerCommand);
+}
+
+size_t NetDisconnectKeepAliveCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDisconnectKeepAliveCommand);
+}
+
+size_t NetDisconnectPlayerCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDisconnectPlayerCommand);
+}
+
+size_t NetPacketRouterQueryCommandMsg::getByteCount() const {
+	return sizeof(NetPacketRouterQueryCommand);
+}
+
+size_t NetPacketRouterAckCommandMsg::getByteCount() const {
+	return sizeof(NetPacketRouterAckCommand);
+}
+
+size_t NetDisconnectVoteCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDisconnectVoteCommand);
+}
+
+size_t NetProgressCommandMsg::getByteCount() const {
+	return sizeof(NetPacketProgressMessage);
+}
+
+size_t NetFileProgressCommandMsg::getByteCount() const {
+	return sizeof(NetPacketFileProgressCommand);
+}
+
+size_t NetDisconnectFrameCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDisconnectFrameCommand);
+}
+
+size_t NetDisconnectScreenOffCommandMsg::getByteCount() const {
+	return sizeof(NetPacketDisconnectScreenOffCommand);
+}
+
+size_t NetFrameResendRequestCommandMsg::getByteCount() const {
+	return sizeof(NetPacketFrameResendRequestCommand);
+}

GeneralsMD/Code/GameEngine/Source/GameNetwork/NetPacket.cpp

@@ -342,70 +342,67 @@ UnsignedInt NetPacket::GetBufferSizeNeededForCommand(NetCommandMsg *msg) {
 }
 
 UnsignedInt NetPacket::GetGameCommandSize(NetCommandMsg *msg) {
-	NetGameCommandMsg *cmdMsg = static_cast<NetGameCommandMsg *>(msg);
-	return cmdMsg->getByteCount();
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetAckCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketAckCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetFrameCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketFrameCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetPlayerLeaveCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketPlayerLeaveCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetRunAheadMetricsCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketRunAheadMetricsCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetRunAheadCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketRunAheadCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDestroyPlayerCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDestroyPlayerCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetKeepAliveCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketKeepAliveCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectKeepAliveCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDisconnectKeepAliveCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectPlayerCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDisconnectPlayerCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetPacketRouterQueryCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketRouterQueryCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetPacketRouterAckCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketRouterAckCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectChatCommandSize(NetCommandMsg *msg) {
-	NetDisconnectChatCommandMsg *cmdMsg = static_cast<NetDisconnectChatCommandMsg*>(msg);
-	return sizeof(NetPacketDisconnectChatCommandHeader) + cmdMsg->getByteCount();
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectVoteCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDisconnectVoteCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetChatCommandSize(NetCommandMsg *msg) {
-	NetChatCommandMsg *cmdMsg = static_cast<NetChatCommandMsg*>(msg);
-	return sizeof(NetPacketChatCommandHeader) + cmdMsg->getByteCount();
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetProgressMessageSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketProgressMessage);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetLoadCompleteMessageSize(NetCommandMsg *msg) {
@@ -417,33 +414,31 @@ UnsignedInt NetPacket::GetTimeOutGameStartMessageSize(NetCommandMsg *msg) {
 }
 
 UnsignedInt NetPacket::GetWrapperCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketWrapperCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetFileCommandSize(NetCommandMsg *msg) {
-	NetFileCommandMsg *filemsg = static_cast<NetFileCommandMsg *>(msg);
-	return sizeof(NetPacketFileCommandHeader) + filemsg->getByteCount();
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetFileAnnounceCommandSize(NetCommandMsg *msg) {
-	NetFileAnnounceCommandMsg *filemsg = static_cast<NetFileAnnounceCommandMsg *>(msg);
-	return sizeof(NetPacketFileAnnounceCommandHeader) + filemsg->getByteCount();
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetFileProgressCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketFileProgressCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectFrameCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDisconnectFrameCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetDisconnectScreenOffCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketDisconnectScreenOffCommand);
+	return msg->getByteCount();
 }
 
 UnsignedInt NetPacket::GetFrameResendRequestCommandSize(NetCommandMsg *msg) {
-	return sizeof(NetPacketFrameResendRequestCommand);
+	return msg->getByteCount();
 }