View source for Packet Header

== UPD Packet Header ==

The communication between the Final Fantasy XI client and server uses the UDP protocol. With this, a sub-protocol must be implemented to create any type of secure transmission that data has properly reached its destination. Final Fantasy XI accomplishes this by implementing a small header to every packet sent between the client and server. This header cotains the following information:
* Packet Id
* Packet Size
* Packet Sync

The packet id informs us of what this packet does. It is the unique identifier to this package.<br>
The packet size informs us of how large the packets payload is.<br>
The packet sync is the counter between the client and server that increments on successful transmissions of packets to help ensure packets are handled in order.<br>

The packet layout can be seen like this:

{| class="wikitable"
! 0 
! 1 
! 2 
! 3 
! 4 
! 5 
! 6 
! 7 
! 8 
! 9 
! A 
! B 
! C 
! D 
! E 
! F
|-
| colspan="1" | Packet Id
| colspan="1" | Size
| colspan="2" | Packet Sync
| colspan="12" | Packet Payload
|}

== Packet ID and Size Information ==

Because packets have gotten over the id of 255, the game needed a way to manage packets over this id range. To remedy this, Final Fantasy XI packs the upper value of the packet id into the size for packets that go over the 255 id threshold. In order to obtain packets true id and size, we must do some minor bit shifting to obtain the proper information packed data. The following can be performed on any packet to obtain its true id and size:
 * To obtain the packet id: (*(unsigned short*)packet) & 0x01FF
 * To obtain the packet size: packet size = *(unsigned char*)(packet + 1) & 0x0FE

Also, keep in mind that packet sizes are divided by two in the packet to account for space for packet ids that go over the 255 threshold. So when obtaining the packet size from the header, be sure to multiply it by two like this:
 * To obtain the true packet size: (*(unsigned char*)(packet + 1) & 0x0FE) * 2