MS4 - Byte Array Packets [Incomplete]

[Jacob]

This is not complete. I need to save what I've written so far.

Packets

In modEnumerations
ENUM ServerPackets- Are for packets going from Server -> Client.
ENUM ClientPackets- Are for packets going from Client -> Server.
* MAKE SURE THE ENUMS ARE EXACTLY THE SAME BOTH SERVER AND CLIENT SIDE!!!!

modHandleData
Sub InitMessages
Add your packet like the others.
Example:

Code:

HandleDataSub(CMsgPlayerRevival) = GetAddress(AddressOf HandlePlayerRevival)

^ Is the ENUM ^ The sub for this packet

HandleDataSub() is an array that will hold the memory address of a sub that deals with that packet.

The following sub is how all the HandleData subs HAVE TO BE!

Code:

Private Sub Handle*(ByVal Index As Long, ByRef Data() As Byte, ByVal StartAddr As Long, ByVal ExtraVar As Long)
Dim Buffer As clsBuffer

    Set Buffer = New clsBuffer
    Buffer.WriteBytes Data()


End Sub

* The name of the packet would go here.


Writing a packet
Example:

Code:

Sub SendPlayerInfoRequest(ByVal Name As String)
Dim Buffer As clsBuffer

    Set Buffer = New clsBuffer
    
    Buffer.PreAllocate Len(Name) + 8    ' PreAllocate is not needed. If you can figure out the size of the packet before hand, do it. It will increase performance.
    Buffer.WriteInteger SMsgPlayerInfoRequest    'Our first long is the packet header. This is used so the handleData knows how to handle it.
    Buffer.WriteString Name    ' This is just some data for this packet
    
    SendData Buffer.ToArray()    ' Sends our data
End Sub

PreAllocate is not needed. If you can figure out the size of the packet before hand, do it. It will increase performance.

When handling the data on the other end, you need to make sure to take the data out in the same order you put it in. The packet header does not count because it automatically gets taken care of.

Example:

Code:

Private Sub HandlePlayerInfoRequest(ByVal Index As Long, ByRef Data() As Byte, ByVal StartAddr As Long, ByVal ExtraVar As Long)
Dim Buffer As clsBuffer
Dim Name As String
Dim n As Long, i As Long

    Set Buffer = New clsBuffer
    Buffer.WriteBytes Data()
    Name = Buffer.ReadString
    
    ' Other stuff here
End sub

[GIAKEN]

Aren't byte array packets already in the engine?

[Jacob]

Yes, this is showing how to use them.

[GIAKEN]

Don't you need to Set Buffer = Nothing when finished to prevent memory leaks?