Do not check for non NULL pointer before HeapFree'ing it. It's
[wine] / dlls / dplayx / dplayx_messages.h
1 /*
2  * Copyright 2000 Peter Hunnisett
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #ifndef __WINE_DPLAYX_MESSAGES__
20 #define __WINE_DPLAYX_MESSAGES__
21
22 #include <stdarg.h>
23
24 #include "windef.h"
25 #include "winbase.h"
26 #include "dplay.h"
27 #include "rpc.h" /* For GUID */
28
29 #include "dplay_global.h"
30
31 DWORD CreateLobbyMessageReceptionThread( HANDLE hNotifyEvent, HANDLE hStart,
32                                          HANDLE hDeath, HANDLE hConnRead );
33
34 HRESULT DP_MSG_SendRequestPlayerId( IDirectPlay2AImpl* This, DWORD dwFlags,
35                                     LPDPID lpdipidAllocatedId );
36 HRESULT DP_MSG_ForwardPlayerCreation( IDirectPlay2AImpl* This, DPID dpidServer );
37
38 void DP_MSG_ReplyReceived( IDirectPlay2AImpl* This, WORD wCommandId,
39                            LPCVOID lpMsgBody, DWORD dwMsgBodySize );
40 void DP_MSG_ErrorReceived( IDirectPlay2AImpl* This, WORD wCommandId,
41                            LPCVOID lpMsgBody, DWORD dwMsgBodySize );
42 void DP_MSG_ToSelf( IDirectPlay2AImpl* This, DPID dpidSelf );
43
44 /* Timings -> 1000 ticks/sec */
45 #define DPMSG_WAIT_5_SECS   5000
46 #define DPMSG_WAIT_30_SECS 30000
47 #define DPMSG_WAIT_60_SECS 60000
48 #define DPMSG_DEFAULT_WAIT_TIME DPMSG_WAIT_30_SECS
49
50 /* Message types etc. */
51 #include "pshpack1.h"
52
53 /* Non provided messages for DPLAY - guess work which may be wrong :( */
54 #define DPMSGCMD_ENUMSESSIONSREPLY    1
55 #define DPMSGCMD_ENUMSESSIONSREQUEST  2
56 #define DPMSGCMD_GETNAMETABLEREPLY    3  /* Contains all existing players in session */
57
58 #define DPMSGCMD_REQUESTNEWPLAYERID   5
59
60 #define DPMSGCMD_NEWPLAYERIDREPLY     7
61 #define DPMSGCMD_CREATESESSION        8 /* Might be a create nameserver or new player msg */
62 #define DPMSGCMD_CREATENEWPLAYER      9
63 #define DPMSGCMD_SYSTEMMESSAGE        10
64 #define DPMSGCMD_DELETEPLAYER         11
65 #define DPMSGCMD_DELETEGROUP          12
66
67 #define DPMSGCMD_ENUMGROUPS           17
68
69 #define DPMSGCMD_FORWARDADDPLAYER     19
70
71 #define DPMSGCMD_PLAYERCHAT           22
72
73 #define DPMSGCMD_FORWARDADDPLAYERNACK 36
74
75 #define DPMSGCMD_JUSTENVELOPE         1000
76 #define DPMSGCMD_JUSTENVELOPEREPLY    1001
77
78 /* This is what DP 6 defines it as. Don't know what it means. All messages
79  * defined below are DPMSGVER_DP6.
80  */
81 #define DPMSGVER_DP6 11
82
83 /* MAGIC number at the start of all dplay packets ("play" in ASCII) */
84 #define DPMSGMAGIC_DPLAYMSG  0x79616c70
85
86 /* All messages sent from the system are sent with this at the beginning of
87  * the message.
88  * Size is 8 bytes
89  */
90 typedef struct tagDPMSG_SENDENVELOPE
91 {
92   DWORD dwMagic;
93   WORD  wCommandId;
94   WORD  wVersion;
95 } DPMSG_SENDENVELOPE, *LPDPMSG_SENDENVELOPE;
96 typedef const DPMSG_SENDENVELOPE* LPCDPMSG_SENDENVELOPE;
97
98 /* System messages exchanged between players seems to have this
99  * payload envelope on top of the basic envelope
100  */
101 typedef struct tagDPMSG_SYSMSGENVELOPE
102 {
103   DWORD dwPlayerFrom;
104   DWORD dwPlayerTo;
105 } DPMSG_SYSMSGENVELOPE, *LPDPMSG_SYSMSGENVELOPE;
106 typedef const DPMSG_SYSMSGENVELOPE* LPCDPMSG_SYSMSGENVELOPE;
107
108 /* Reply sent in response to an enumsession request */
109 typedef struct tagDPMSG_ENUMSESSIONSREPLY
110 {
111   DPMSG_SENDENVELOPE envelope;
112
113 #if 0
114   DWORD dwSize;  /* Size of DPSESSIONDESC2 struct */
115   DWORD dwFlags; /* Sessions flags */
116
117   GUID guidInstance; /* Not 100% sure this is what it is... */
118
119   GUID guidApplication;
120
121   DWORD dwMaxPlayers;
122   DWORD dwCurrentPlayers;
123
124   BYTE unknown[36];
125 #else
126   DPSESSIONDESC2 sd;
127 #endif
128
129   DWORD dwUnknown;  /* Seems to be equal to 0x5c which is a "\\" */
130                     /* Encryption package string? */
131
132   /* At the end we have ... */
133   /* WCHAR wszSessionName[1];  Var length with NULL terminal */
134
135 } DPMSG_ENUMSESSIONSREPLY, *LPDPMSG_ENUMSESSIONSREPLY;
136 typedef const DPMSG_ENUMSESSIONSREPLY* LPCDPMSG_ENUMSESSIONSREPLY;
137
138 /* Msg sent to find out what sessions are available */
139 typedef struct tagDPMSG_ENUMSESSIONSREQUEST
140 {
141   DPMSG_SENDENVELOPE envelope;
142
143   GUID  guidApplication;
144
145   DWORD dwPasswordSize; /* A Guess. This is 0x00000000. */
146                         /* This might be the name server DPID which
147                            is needed for the reply */
148
149   DWORD dwFlags; /* dwFlags from EnumSessions */
150
151 } DPMSG_ENUMSESSIONSREQUEST, *LPDPMSG_ENUMSESSIONSREQUEST;
152 typedef const DPMSG_ENUMSESSIONSREQUEST* LPCDPMSG_ENUMSESSIONSREQUEST;
153
154 /* Size is 146 received - with 18 or 20 bytes header = ~128 bytes */
155 typedef struct tagDPMSG_CREATESESSION
156 {
157   DPMSG_SENDENVELOPE envelope;
158 } DPMSG_CREATESESSION, *LPDPMSG_CREATESESSION;
159 typedef const DPMSG_CREATESESSION* LPCDPMSG_CREATESESSION;
160
161 /* 12 bytes msg */
162 typedef struct tagDPMSG_REQUESTNEWPLAYERID
163 {
164   DPMSG_SENDENVELOPE envelope;
165
166   DWORD dwFlags;  /* dwFlags used for CreatePlayer */
167
168 } DPMSG_REQUESTNEWPLAYERID, *LPDPMSG_REQUESTNEWPLAYERID;
169 typedef const DPMSG_REQUESTNEWPLAYERID* LPCDPMSG_REQUESTNEWPLAYERID;
170
171 /* 48 bytes msg */
172 typedef struct tagDPMSG_NEWPLAYERIDREPLY
173 {
174   DPMSG_SENDENVELOPE envelope;
175
176   DPID dpidNewPlayerId;
177
178   /* Assume that this is data that is tacked on to the end of the message
179    * that comes from the SP remote data stored that needs to be propagated.
180    */
181   BYTE unknown[36];     /* This appears to always be 0 - not sure though */
182 } DPMSG_NEWPLAYERIDREPLY, *LPDPMSG_NEWPLAYERIDREPLY;
183 typedef const DPMSG_NEWPLAYERIDREPLY* LPCDPMSG_NEWPLAYERIDREPLY;
184
185 typedef struct tagDPMSG_FORWARDADDPLAYER
186 {
187   DPMSG_SENDENVELOPE envelope;
188
189   DWORD unknown; /* 0 */
190
191   DPID  dpidAppServer; /* Remote application server id */
192   DWORD unknown2[5]; /* 0x0, 0x1c, 0x6c, 0x50, 0x9 */
193
194   DPID  dpidAppServer2; /* Remote application server id again !? */
195   DWORD unknown3[5]; /* 0x0, 0x0, 0x20, 0x0, 0x0 */
196
197   DPID  dpidAppServer3; /* Remote application server id again !? */
198
199   DWORD unknown4[12]; /* ??? - Is this a clump of 5 and then 8? */
200                       /* NOTE: 1 byte in front of the two 0x??090002 entries changes!
201                       *       Is it a timestamp of some sort? 1st always smaller than
202                       *       other...
203                       */
204 #define FORWARDADDPLAYER_UNKNOWN4_INIT { 0x30, 0xb, 0x0, 0x1e090002, 0x0, 0x0, 0x0, 0x32090002, 0x0, 0x0, 0x0, 0x0 }
205
206   BYTE unknown5[2]; /* 2 bytes at the end. This may be a part of something! ( 0x0, 0x0) */
207
208 } DPMSG_FORWARDADDPLAYER, *LPDPMSG_FORWARDADDPLAYER;
209 typedef const DPMSG_FORWARDADDPLAYER* LPCDPMSG_FORWARDADDPLAYER;
210
211 /* This is an error message that can be received. Not sure if this is
212  * specifically for a forward add player or for all errors
213  */
214 typedef struct tagDPMSG_FORWARDADDPLAYERNACK
215 {
216   DPMSG_SENDENVELOPE envelope;
217   HRESULT errorCode;
218 } DPMSG_FORWARDADDPLAYERNACK, *LPDPMSG_FORWARDADDPLAYERNACK;
219 typedef const DPMSG_FORWARDADDPLAYERNACK* LPCDPMSG_FORWARDADDPLAYERNACK;
220
221 #include "poppack.h"
222
223 #endif