Skip to content

Commit 9479df5

Browse files
xezonxezon
committed
refactor(netpacket): Use more consistent names for packed net packet structs (#2283)
1 parent 1a30bfe commit 9479df5

3 files changed

Lines changed: 47 additions & 47 deletions

File tree

‎Core/GameEngine/Include/GameNetwork/NetPacketStructs.h‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ struct NetPacketCommandIdField {
7070
UnsignedShort commandId;
7171
};
7272

73-
struct NetPacketDataFieldHeader {
73+
struct NetPacketDataField {
7474
char header;
7575
};
7676

@@ -81,7 +81,7 @@ struct NetPacketDataFieldHeader {
8181
struct NetPacketAckCommand {
8282
NetPacketCommandTypeField commandType;
8383
NetPacketPlayerIdField playerId;
84-
NetPacketDataFieldHeader dataHeader;
84+
NetPacketDataField dataHeader;
8585
UnsignedShort commandId; // Command ID being acknowledged
8686
UnsignedByte originalPlayerId; // Original player who sent the command
8787
};
@@ -92,7 +92,7 @@ struct NetPacketFrameCommand {
9292
NetPacketRelayField relay;
9393
NetPacketPlayerIdField playerId;
9494
NetPacketCommandIdField commandId;
95-
NetPacketDataFieldHeader dataHeader;
95+
NetPacketDataField dataHeader;
9696
UnsignedShort commandCount;
9797
};
9898

@@ -102,7 +102,7 @@ struct NetPacketPlayerLeaveCommand {
102102
NetPacketFrameField frame;
103103
NetPacketPlayerIdField playerId;
104104
NetPacketCommandIdField commandId;
105-
NetPacketDataFieldHeader dataHeader;
105+
NetPacketDataField dataHeader;
106106
UnsignedByte leavingPlayerId;
107107
};
108108

@@ -111,7 +111,7 @@ struct NetPacketRunAheadMetricsCommand {
111111
NetPacketRelayField relay;
112112
NetPacketPlayerIdField playerId;
113113
NetPacketCommandIdField commandId;
114-
NetPacketDataFieldHeader dataHeader;
114+
NetPacketDataField dataHeader;
115115
Real averageLatency;
116116
UnsignedShort averageFps;
117117
};
@@ -122,7 +122,7 @@ struct NetPacketRunAheadCommand {
122122
NetPacketFrameField frame;
123123
NetPacketPlayerIdField playerId;
124124
NetPacketCommandIdField commandId;
125-
NetPacketDataFieldHeader dataHeader;
125+
NetPacketDataField dataHeader;
126126
UnsignedShort runAhead;
127127
UnsignedByte frameRate;
128128
};
@@ -133,30 +133,30 @@ struct NetPacketDestroyPlayerCommand {
133133
NetPacketFrameField frame;
134134
NetPacketPlayerIdField playerId;
135135
NetPacketCommandIdField commandId;
136-
NetPacketDataFieldHeader dataHeader;
136+
NetPacketDataField dataHeader;
137137
UnsignedInt playerIndex;
138138
};
139139

140140
struct NetPacketKeepAliveCommand {
141141
NetPacketCommandTypeField commandType;
142142
NetPacketRelayField relay;
143143
NetPacketPlayerIdField playerId;
144-
NetPacketDataFieldHeader dataHeader;
144+
NetPacketDataField dataHeader;
145145
};
146146

147147
struct NetPacketDisconnectKeepAliveCommand {
148148
NetPacketCommandTypeField commandType;
149149
NetPacketRelayField relay;
150150
NetPacketPlayerIdField playerId;
151-
NetPacketDataFieldHeader dataHeader;
151+
NetPacketDataField dataHeader;
152152
};
153153

154154
struct NetPacketDisconnectPlayerCommand {
155155
NetPacketCommandTypeField commandType;
156156
NetPacketRelayField relay;
157157
NetPacketPlayerIdField playerId;
158158
NetPacketCommandIdField commandId;
159-
NetPacketDataFieldHeader dataHeader;
159+
NetPacketDataField dataHeader;
160160
UnsignedByte slot;
161161
UnsignedInt disconnectFrame;
162162
};
@@ -165,53 +165,53 @@ struct NetPacketRouterQueryCommand {
165165
NetPacketCommandTypeField commandType;
166166
NetPacketRelayField relay;
167167
NetPacketPlayerIdField playerId;
168-
NetPacketDataFieldHeader dataHeader;
168+
NetPacketDataField dataHeader;
169169
};
170170

171171
struct NetPacketRouterAckCommand {
172172
NetPacketCommandTypeField commandType;
173173
NetPacketRelayField relay;
174174
NetPacketPlayerIdField playerId;
175-
NetPacketDataFieldHeader dataHeader;
175+
NetPacketDataField dataHeader;
176176
};
177177

178178
struct NetPacketDisconnectVoteCommand {
179179
NetPacketCommandTypeField commandType;
180180
NetPacketRelayField relay;
181181
NetPacketPlayerIdField playerId;
182182
NetPacketCommandIdField commandId;
183-
NetPacketDataFieldHeader dataHeader;
183+
NetPacketDataField dataHeader;
184184
UnsignedByte slot;
185185
UnsignedInt voteFrame;
186186
};
187187

188-
struct NetPacketChatCommandHeader {
188+
struct NetPacketChatCommand {
189189
NetPacketCommandTypeField commandType;
190190
NetPacketFrameField frame;
191191
NetPacketRelayField relay;
192192
NetPacketPlayerIdField playerId;
193193
NetPacketCommandIdField commandId;
194-
NetPacketDataFieldHeader dataHeader;
194+
NetPacketDataField dataHeader;
195195
UnsignedByte textLength;
196196
// Variable fields: WideChar text[textLength] + Int playerMask
197197
};
198198

199-
struct NetPacketDisconnectChatCommandHeader {
199+
struct NetPacketDisconnectChatCommand {
200200
NetPacketCommandTypeField commandType;
201201
NetPacketRelayField relay;
202202
NetPacketPlayerIdField playerId;
203-
NetPacketDataFieldHeader dataHeader;
203+
NetPacketDataField dataHeader;
204204
UnsignedByte textLength;
205205
// Variable fields: WideChar text[textLength]
206206
};
207207

208-
struct NetPacketGameCommandHeader {
208+
struct NetPacketGameCommand {
209209
NetPacketCommandTypeField commandType;
210210
NetPacketFrameField frame;
211211
NetPacketRelayField relay;
212212
NetPacketPlayerIdField playerId;
213213
NetPacketCommandIdField commandId;
214-
NetPacketDataFieldHeader dataHeader;
214+
NetPacketDataField dataHeader;
215215
// Variable fields: GameMessage type + argument types + argument data
216216
};
217217

@@ -220,7 +220,7 @@ struct NetPacketWrapperCommand {
220220
NetPacketRelayField relay;
221221
NetPacketPlayerIdField playerId;
222222
NetPacketCommandIdField commandId;
223-
NetPacketDataFieldHeader dataHeader;
223+
NetPacketDataField dataHeader;
224224
UnsignedShort wrappedCommandId;
225225
UnsignedInt chunkNumber;
226226
UnsignedInt numChunks;
@@ -234,7 +234,7 @@ struct NetPacketFileCommand {
234234
NetPacketRelayField relay;
235235
NetPacketPlayerIdField playerId;
236236
NetPacketCommandIdField commandId;
237-
NetPacketDataFieldHeader dataHeader;
237+
NetPacketDataField dataHeader;
238238
// Variable fields: null-terminated filename + UnsignedInt fileDataLength + file data
239239
};
240240

@@ -243,7 +243,7 @@ struct NetPacketFileAnnounceCommand {
243243
NetPacketRelayField relay;
244244
NetPacketPlayerIdField playerId;
245245
NetPacketCommandIdField commandId;
246-
NetPacketDataFieldHeader dataHeader;
246+
NetPacketDataField dataHeader;
247247
// Variable fields: null-terminated filename + UnsignedShort fileID + UnsignedByte playerMask
248248
};
249249

@@ -252,41 +252,41 @@ struct NetPacketFileProgressCommand {
252252
NetPacketRelayField relay;
253253
NetPacketPlayerIdField playerId;
254254
NetPacketCommandIdField commandId;
255-
NetPacketDataFieldHeader dataHeader;
255+
NetPacketDataField dataHeader;
256256
UnsignedShort fileId;
257257
Int progress;
258258
};
259259

260-
struct NetPacketProgressMessage {
260+
struct NetPacketProgressCommand {
261261
NetPacketCommandTypeField commandType;
262262
NetPacketRelayField relay;
263263
NetPacketPlayerIdField playerId;
264-
NetPacketDataFieldHeader dataHeader;
264+
NetPacketDataField dataHeader;
265265
UnsignedByte percentage;
266266
};
267267

268-
struct NetPacketLoadCompleteMessage {
268+
struct NetPacketLoadCompleteCommand {
269269
NetPacketCommandTypeField commandType;
270270
NetPacketRelayField relay;
271271
NetPacketPlayerIdField playerId;
272272
NetPacketCommandIdField commandId;
273-
NetPacketDataFieldHeader dataHeader;
273+
NetPacketDataField dataHeader;
274274
};
275275

276-
struct NetPacketTimeOutGameStartMessage {
276+
struct NetPacketTimeOutGameStartCommand {
277277
NetPacketCommandTypeField commandType;
278278
NetPacketRelayField relay;
279279
NetPacketPlayerIdField playerId;
280280
NetPacketCommandIdField commandId;
281-
NetPacketDataFieldHeader dataHeader;
281+
NetPacketDataField dataHeader;
282282
};
283283

284284
struct NetPacketDisconnectFrameCommand {
285285
NetPacketCommandTypeField commandType;
286286
NetPacketRelayField relay;
287287
NetPacketPlayerIdField playerId;
288288
NetPacketCommandIdField commandId;
289-
NetPacketDataFieldHeader dataHeader;
289+
NetPacketDataField dataHeader;
290290
UnsignedInt disconnectFrame;
291291
};
292292

@@ -295,7 +295,7 @@ struct NetPacketDisconnectScreenOffCommand {
295295
NetPacketRelayField relay;
296296
NetPacketPlayerIdField playerId;
297297
NetPacketCommandIdField commandId;
298-
NetPacketDataFieldHeader dataHeader;
298+
NetPacketDataField dataHeader;
299299
UnsignedInt newFrame;
300300
};
301301

@@ -304,7 +304,7 @@ struct NetPacketFrameResendRequestCommand {
304304
NetPacketRelayField relay;
305305
NetPacketPlayerIdField playerId;
306306
NetPacketCommandIdField commandId;
307-
NetPacketDataFieldHeader dataHeader;
307+
NetPacketDataField dataHeader;
308308
UnsignedInt frameToResend;
309309
};
310310

‎Core/GameEngine/Source/GameNetwork/NetCommandMsg.cpp‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ void NetGameCommandMsg::setGameMessageType(GameMessage::Type type) {
225225
}
226226

227227
size_t NetGameCommandMsg::getPackedByteCount() const {
228-
UnsignedShort msglen = sizeof(NetPacketGameCommandHeader);
228+
UnsignedShort msglen = sizeof(NetPacketGameCommand);
229229

230230
// Variable data portion
231231
GameMessage *gmsg = constructGameMessage();
@@ -870,7 +870,7 @@ void NetChatCommandMsg::setPlayerMask( Int playerMask )
870870

871871
size_t NetChatCommandMsg::getPackedByteCount() const
872872
{
873-
return sizeof(NetPacketChatCommandHeader)
873+
return sizeof(NetPacketChatCommand)
874874
+ m_text.getByteCount()
875875
+ sizeof(m_playerMask);
876876
}
@@ -880,7 +880,7 @@ size_t NetChatCommandMsg::getPackedByteCount() const
880880
//-------------------------
881881
size_t NetDisconnectChatCommandMsg::getPackedByteCount() const
882882
{
883-
return sizeof(NetPacketDisconnectChatCommandHeader)
883+
return sizeof(NetPacketDisconnectChatCommand)
884884
+ m_text.getByteCount();
885885
}
886886

@@ -955,7 +955,7 @@ void NetProgressCommandMsg::setPercentage( UnsignedByte percent )
955955
}
956956

957957
size_t NetProgressCommandMsg::getPackedByteCount() const {
958-
return sizeof(NetPacketProgressMessage);
958+
return sizeof(NetPacketProgressCommand);
959959
}
960960

961961
//-------------------------
@@ -1244,7 +1244,7 @@ NetLoadCompleteCommandMsg::~NetLoadCompleteCommandMsg() {
12441244
}
12451245

12461246
size_t NetLoadCompleteCommandMsg::getPackedByteCount() const {
1247-
return sizeof(NetPacketLoadCompleteMessage);
1247+
return sizeof(NetPacketLoadCompleteCommand);
12481248
}
12491249

12501250
//-------------------------
@@ -1258,5 +1258,5 @@ NetTimeOutGameStartCommandMsg::~NetTimeOutGameStartCommandMsg() {
12581258
}
12591259

12601260
size_t NetTimeOutGameStartCommandMsg::getPackedByteCount() const {
1261-
return sizeof(NetPacketTimeOutGameStartMessage);
1261+
return sizeof(NetPacketTimeOutGameStartCommand);
12621262
}

‎Core/GameEngine/Source/GameNetwork/NetPacket.cpp‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ void NetPacket::FillBufferWithGameCommand(UnsignedByte *buffer, NetCommandRef *m
377377

378378
//DEBUG_LOG_LEVEL(DEBUG_LEVEL_NET, ("NetPacket::FillBufferWithGameCommand for command ID %d", cmdMsg->getID()));
379379

380-
NetPacketGameCommandHeader* packet = reinterpret_cast<NetPacketGameCommandHeader*>(buffer);
380+
NetPacketGameCommand* packet = reinterpret_cast<NetPacketGameCommand*>(buffer);
381381
packet->commandType.header = NetPacketFieldTypes::CommandType;
382382
packet->commandType.commandType = cmdMsg->getNetCommandType();
383383
packet->frame.header = NetPacketFieldTypes::Frame;
@@ -391,7 +391,7 @@ void NetPacket::FillBufferWithGameCommand(UnsignedByte *buffer, NetCommandRef *m
391391
packet->dataHeader.header = NetPacketFieldTypes::Data;
392392

393393
// Variable data portion
394-
UnsignedShort offset = sizeof(NetPacketGameCommandHeader);
394+
UnsignedShort offset = sizeof(NetPacketGameCommand);
395395

396396
// Now copy the GameMessage type into the packet.
397397
GameMessage::Type newType = gmsg->getType();
@@ -704,7 +704,7 @@ void NetPacket::FillBufferWithDisconnectChatCommand(UnsignedByte *buffer, NetCom
704704
NetDisconnectChatCommandMsg *cmdMsg = (NetDisconnectChatCommandMsg *)(msg->getCommand());
705705
// DEBUG_LOG_LEVEL(DEBUG_LEVEL_NET, ("NetPacket::addDisconnectChatCommand - adding run ahead command"));
706706

707-
NetPacketDisconnectChatCommandHeader* packet = reinterpret_cast<NetPacketDisconnectChatCommandHeader*>(buffer);
707+
NetPacketDisconnectChatCommand* packet = reinterpret_cast<NetPacketDisconnectChatCommand*>(buffer);
708708
packet->commandType.header = NetPacketFieldTypes::CommandType;
709709
packet->commandType.commandType = cmdMsg->getNetCommandType();
710710
packet->relay.header = NetPacketFieldTypes::Relay;
@@ -717,7 +717,7 @@ void NetPacket::FillBufferWithDisconnectChatCommand(UnsignedByte *buffer, NetCom
717717
packet->textLength = unitext.getLength();
718718

719719
// Variable data portion
720-
UnsignedShort offset = sizeof(NetPacketDisconnectChatCommandHeader);
720+
UnsignedShort offset = sizeof(NetPacketDisconnectChatCommand);
721721
memcpy(buffer + offset, unitext.str(), packet->textLength * sizeof(UnsignedShort));
722722
offset += packet->textLength * sizeof(UnsignedShort);
723723
}
@@ -744,7 +744,7 @@ void NetPacket::FillBufferWithChatCommand(UnsignedByte *buffer, NetCommandRef *m
744744
NetChatCommandMsg *cmdMsg = static_cast<NetChatCommandMsg *>(msg->getCommand());
745745
// DEBUG_LOG_LEVEL(DEBUG_LEVEL_NET, ("NetPacket::addDisconnectChatCommand - adding run ahead command"));
746746

747-
NetPacketChatCommandHeader* packet = reinterpret_cast<NetPacketChatCommandHeader*>(buffer);
747+
NetPacketChatCommand* packet = reinterpret_cast<NetPacketChatCommand*>(buffer);
748748
packet->commandType.header = NetPacketFieldTypes::CommandType;
749749
packet->commandType.commandType = cmdMsg->getNetCommandType();
750750
packet->frame.header = NetPacketFieldTypes::Frame;
@@ -761,7 +761,7 @@ void NetPacket::FillBufferWithChatCommand(UnsignedByte *buffer, NetCommandRef *m
761761
packet->textLength = unitext.getLength();
762762

763763
// Variable data portion
764-
UnsignedShort offset = sizeof(NetPacketChatCommandHeader);
764+
UnsignedShort offset = sizeof(NetPacketChatCommand);
765765
memcpy(buffer + offset, unitext.str(), packet->textLength * sizeof(UnsignedShort));
766766
offset += packet->textLength * sizeof(UnsignedShort);
767767

@@ -773,7 +773,7 @@ void NetPacket::FillBufferWithChatCommand(UnsignedByte *buffer, NetCommandRef *m
773773
void NetPacket::FillBufferWithProgressMessage(UnsignedByte *buffer, NetCommandRef *msg) {
774774
NetProgressCommandMsg *cmdMsg = (NetProgressCommandMsg *)(msg->getCommand());
775775

776-
NetPacketProgressMessage* packet = reinterpret_cast<NetPacketProgressMessage*>(buffer);
776+
NetPacketProgressCommand* packet = reinterpret_cast<NetPacketProgressCommand*>(buffer);
777777
packet->commandType.header = NetPacketFieldTypes::CommandType;
778778
packet->commandType.commandType = cmdMsg->getNetCommandType();
779779
packet->relay.header = NetPacketFieldTypes::Relay;
@@ -787,7 +787,7 @@ void NetPacket::FillBufferWithProgressMessage(UnsignedByte *buffer, NetCommandRe
787787
void NetPacket::FillBufferWithLoadCompleteMessage(UnsignedByte *buffer, NetCommandRef *msg) {
788788
NetCommandMsg *cmdMsg = static_cast<NetCommandMsg *>(msg->getCommand());
789789

790-
NetPacketLoadCompleteMessage* packet = reinterpret_cast<NetPacketLoadCompleteMessage*>(buffer);
790+
NetPacketLoadCompleteCommand* packet = reinterpret_cast<NetPacketLoadCompleteCommand*>(buffer);
791791
packet->commandType.header = NetPacketFieldTypes::CommandType;
792792
packet->commandType.commandType = cmdMsg->getNetCommandType();
793793
packet->relay.header = NetPacketFieldTypes::Relay;
@@ -802,7 +802,7 @@ void NetPacket::FillBufferWithLoadCompleteMessage(UnsignedByte *buffer, NetComma
802802
void NetPacket::FillBufferWithTimeOutGameStartMessage(UnsignedByte *buffer, NetCommandRef *msg) {
803803
NetCommandMsg *cmdMsg = static_cast<NetCommandMsg *>(msg->getCommand());
804804

805-
NetPacketTimeOutGameStartMessage* packet = reinterpret_cast<NetPacketTimeOutGameStartMessage*>(buffer);
805+
NetPacketTimeOutGameStartCommand* packet = reinterpret_cast<NetPacketTimeOutGameStartCommand*>(buffer);
806806
packet->commandType.header = NetPacketFieldTypes::CommandType;
807807
packet->commandType.commandType = cmdMsg->getNetCommandType();
808808
packet->relay.header = NetPacketFieldTypes::Relay;

0 commit comments

Comments
 (0)