2 * Copyright (C) 1999 Francois Gouget
3 * Copyright (C) 1999 Peter Hunnisett
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #ifndef __WINE_DPLOBBY_H
21 #define __WINE_DPLOBBY_H
27 #endif /* defined(__cplusplus) */
29 /*****************************************************************************
30 * Predeclare the interfaces
32 DEFINE_GUID(CLSID_DirectPlayLobby, 0x2fe8f810, 0xb2a5, 0x11d0, 0xa7, 0x87, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
34 DEFINE_GUID(IID_IDirectPlayLobby, 0xaf465c71, 0x9588, 0x11cf, 0xa0, 0x20, 0x0, 0xaa, 0x0, 0x61, 0x57, 0xac);
35 typedef struct IDirectPlayLobby IDirectPlayLobby,*LPDIRECTPLAYLOBBY;
37 DEFINE_GUID(IID_IDirectPlayLobbyA, 0x26c66a70, 0xb367, 0x11cf, 0xa0, 0x24, 0x0, 0xaa, 0x0, 0x61, 0x57, 0xac);
38 typedef struct IDirectPlayLobby IDirectPlayLobbyA,*LPDIRECTPLAYLOBBYA;
40 DEFINE_GUID(IID_IDirectPlayLobby2, 0x194c220, 0xa303, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
41 typedef struct IDirectPlayLobby2 IDirectPlayLobby2, *LPDIRECTPLAYLOBBY2;
43 DEFINE_GUID(IID_IDirectPlayLobby2A, 0x1bb4af80, 0xa303, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
44 typedef struct IDirectPlayLobby2 IDirectPlayLobby2A, *LPDIRECTPLAYLOBBY2A;
46 DEFINE_GUID(IID_IDirectPlayLobby3, 0x2db72490, 0x652c, 0x11d1, 0xa7, 0xa8, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
47 typedef struct IDirectPlayLobby3 IDirectPlayLobby3, *LPDIRECTPLAYLOBBY3;
49 DEFINE_GUID(IID_IDirectPlayLobby3A, 0x2db72491, 0x652c, 0x11d1, 0xa7, 0xa8, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
50 typedef struct IDirectPlayLobby3 IDirectPlayLobby3A, *LPDIRECTPLAYLOBBY3A;
53 /*****************************************************************************
54 * DirectPlayLobby Property GUIDs used in lobby messages
57 /* DPLPROPERTY_MessagesSupported {762CCDA1-D916-11d0-BA39-00C04FD7ED67}.
58 * Purpose: Request if the lobby supports standard (?).
59 * Response: Answer is a BOOL. TRUE if supports the standard (?) and FALSE otherwise. Of course, it might not respond at all.
61 DEFINE_GUID(DPLPROPERTY_MessagesSupported, 0x762ccda1, 0xd916, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
63 /* DPLPROPERTY_LobbyGuid {F56920A0-D218-11d0-BA39-00C04FD7ED67}.
64 * Purpose: Request the GUID that identifies the lobby version that the application is communicating with.
65 * Response: The GUID which identifies the lobby version
67 DEFINE_GUID(DPLPROPERTY_LobbyGuid, 0xf56920a0, 0xd218, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
69 /* DPLPROPERTY_PlayerGuid {B4319322-D20D-11d0-BA39-00C04FD7ED67}
70 * Purpose: Request the GUID that identifies the player for this particular machine.
71 * Response: DPLDATA_PLAYERDATA structure.
73 DEFINE_GUID(DPLPROPERTY_PlayerGuid, 0xb4319322, 0xd20d, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
75 /* DPLPROPERTY_PlayerScore {48784000-D219-11d0-BA39-00C04FD7ED67}
76 * Purpose: Used to send a score of a player to the lobby. The format is an array of long integers.
77 * Response: I don't think there is one.
79 DEFINE_GUID(DPLPROPERTY_PlayerScore, 0x48784000, 0xd219, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
83 /*****************************************************************************
84 * LOBBY structures associated with GUID messages
87 typedef struct tagDPLDATA_PLAYERGUID
91 } DPLDATA_PLAYERGUID, *LPDPLDATA_PLAYERGUID;
93 typedef struct tagDPLDATA_PLAYERSCORE
97 } DPLDATA_PLAYERSCORE, *LPDPLDATA_PLAYERSCORE;
100 /*****************************************************************************
101 * LOBBY messages and message data structures.
103 * System messages can be identified by dwMessageFlags having a value of DPLMSG_SYSTEM
104 * after a call to ReceiveLobbyMessage.
106 * Standard messages can be indentified by dwMessageFlags having a value of DPLMSG_STANDARD
107 * after a call to ReceiveLobbyMessage.
110 /* DPLobby1 definition required for backwards compatibility */
111 #define DPLMSG_SYSTEM 0x00000001
112 #define DPLMSG_STANDARD 0x00000002
113 #define DPLAD_SYSTEM DPLMSG_SYSTEM
116 /* System messages - dwType field for messages */
117 #define DPLSYS_CONNECTIONSETTINGSREAD 0x00000001
118 #define DPLSYS_DPLAYCONNECTFAILED 0x00000002
119 #define DPLSYS_DPLAYCONNECTSUCCEEDED 0x00000003
120 #define DPLSYS_APPTERMINATED 0x00000004
121 #define DPLSYS_SETPROPERTY 0x00000005
122 #define DPLSYS_SETPROPERTYRESPONSE 0x00000006
123 #define DPLSYS_GETPROPERTY 0x00000007
124 #define DPLSYS_GETPROPERTYRESPONSE 0x00000008
125 #define DPLSYS_NEWSESSIONHOST 0x00000009
126 #define DPLSYS_NEWCONNECTIONSETTINGS 0x0000000A
130 /* Used to indentify the message type */
131 typedef struct tagDPLMSG_GENERIC
133 DWORD dwType; /* Message type */
134 } DPLMSG_GENERIC, *LPDPLMSG_GENERIC;
136 /* Generic format for system messages - see above */
137 typedef struct tagDPLMSG_SYSTEMMESSAGE
139 DWORD dwType; /* Message type */
140 GUID guidInstance; /* Instance GUID of the dplay session the message corresponds to */
141 } DPLMSG_SYSTEMMESSAGE, *LPDPLMSG_SYSTEMMESSAGE;
143 /* Generic message to set a property - see property GUIDs above */
144 typedef struct tagDPLMSG_SETPROPERTY
146 DWORD dwType; /* Message type */
147 DWORD dwRequestID; /* Request ID (DPL_NOCONFIRMATION if no confirmation desired) */
148 GUID guidPlayer; /* Player GUID */
149 GUID guidPropertyTag; /* Property GUID */
150 DWORD dwDataSize; /* Size of data */
151 DWORD dwPropertyData[1]; /* Buffer containing data */
152 } DPLMSG_SETPROPERTY, *LPDPLMSG_SETPROPERTY;
154 #define DPL_NOCONFIRMATION 0L
156 /* Reply to DPLMSG_SETPROPERTY */
157 typedef struct tagDPLMSG_SETPROPERTYRESPONSE
159 DWORD dwType; /* Message type */
160 DWORD dwRequestID; /* Request ID */
161 GUID guidPlayer; /* Player GUID */
162 GUID guidPropertyTag; /* Property GUID */
163 HRESULT hr; /* Return Code */
164 } DPLMSG_SETPROPERTYRESPONSE, *LPDPLMSG_SETPROPERTYRESPONSE;
166 /* Request to get the present value of a property */
167 typedef struct tagDPLMSG_GETPROPERTY
169 DWORD dwType; /* Message type */
170 DWORD dwRequestID; /* Request ID */
171 GUID guidPlayer; /* Player GUID */
172 GUID guidPropertyTag; /* Property GUID */
173 } DPLMSG_GETPROPERTY, *LPDPLMSG_GETPROPERTY;
175 /* Response to a request to get the present value of a property */
176 typedef struct tagDPLMSG_GETPROPERTYRESPONSE
178 DWORD dwType; /* Message type */
179 DWORD dwRequestID; /* Request ID */
180 GUID guidPlayer; /* Player GUID */
181 GUID guidPropertyTag; /* Property GUID */
182 HRESULT hr; /* Return Code */
183 DWORD dwDataSize; /* Size of data */
184 DWORD dwPropertyData[1]; /* Buffer containing data */
185 } DPLMSG_GETPROPERTYRESPONSE, *LPDPLMSG_GETPROPERTYRESPONSE;
187 /* Standard message in response to a session host migration to a new client */
188 typedef struct tagDPLMSG_NEWSESSIONHOST
190 DWORD dwType; /* Message type */
191 GUID guidInstance; /* GUID Instance of the session */
192 } DPLMSG_NEWSESSIONHOST, *LPDPLMSG_NEWSESSIONHOST;
194 /*****************************************************************************
195 * DirectPlay Address ID's
196 * A DirectPlay address is composed of multiple data chunks, each assocated with
197 * a GUID to give significance to the type of data. All chunks have an associated
198 * size so that unknown chunks can be ignored for backwards compatibility!
199 * EnumAddresses function is used to parse the address data chunks.
202 /* DPAID_TotalSize {1318F560-912C-11d0-9DAA-00A0C90A43CB}
203 * Chunk purpose: Chunk is a DWORD containing the size of the entire DPADDRESS struct
205 DEFINE_GUID(DPAID_TotalSize, 0x1318f560, 0x912c, 0x11d0, 0x9d, 0xaa, 0x0, 0xa0, 0xc9, 0xa, 0x43, 0xcb);
207 /* DPAID_ServiceProvider {07D916C0-E0AF-11cf-9C4E-00A0C905425E}
208 * Chunk purpose: Chunk is a GUID indicated what service provider created the chunk.
210 DEFINE_GUID(DPAID_ServiceProvider, 0x7d916c0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
212 /* DPAID_LobbyProvider {59B95640-9667-11d0-A77D-0000F803ABFC}
213 * Chunk purpose: Chunk is a GUID indicating what lobby provider created the chunk.
215 DEFINE_GUID(DPAID_LobbyProvider, 0x59b95640, 0x9667, 0x11d0, 0xa7, 0x7d, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
217 /* DPAID_Phone {78EC89A0-E0AF-11cf-9C4E-00A0C905425E} -- ANSI
218 * DPAID_PhoneW {BA5A7A70-9DBF-11d0-9CC1-00A0C905425E} -- UNICODE
219 * Chunk purpose: Chunk is a phone number in ANSI or UNICODE format
221 DEFINE_GUID(DPAID_Phone, 0x78ec89a0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
222 DEFINE_GUID(DPAID_PhoneW, 0xba5a7a70, 0x9dbf, 0x11d0, 0x9c, 0xc1, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
224 /* DPAID_Modem {F6DCC200-A2FE-11d0-9C4F-00A0C905425E} -- ANSI
225 * DPAID_ModemW {01FD92E0-A2FF-11d0-9C4F-00A0C905425E} -- UNICODE
226 * Chunk purpose: Chunk is a modem name registered with TAPI
228 DEFINE_GUID(DPAID_Modem, 0xf6dcc200, 0xa2fe, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
229 DEFINE_GUID(DPAID_ModemW, 0x1fd92e0, 0xa2ff, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
231 /* DPAID_INet {C4A54DA0-E0AF-11cf-9C4E-00A0C905425E} -- ANSI
232 * DPAID_INetW {E63232A0-9DBF-11d0-9CC1-00A0C905425E} -- UNICODE
233 * Chunk purpose: Chunk is a string containing a TCP/IP host name or IP address
235 DEFINE_GUID(DPAID_INet, 0xc4a54da0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
236 DEFINE_GUID(DPAID_INetW, 0xe63232a0, 0x9dbf, 0x11d0, 0x9c, 0xc1, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
238 /* DPAID_INetPort {E4524541-8EA5-11d1-8A96-006097B01411}
239 * Chunk purpose: Chunk is a port number used for creating TCP and UDP sockets. (WORD)
241 DEFINE_GUID(DPAID_INetPort, 0xe4524541, 0x8ea5, 0x11d1, 0x8a, 0x96, 0x0, 0x60, 0x97, 0xb0, 0x14, 0x11);
243 /* DPAID_ComPort {F2F0CE00-E0AF-11cf-9C4E-00A0C905425E}
244 * Chunk purpose: Chunk contains the description of a serial port.
246 DEFINE_GUID(DPAID_ComPort, 0xf2f0ce00, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
249 /* Header block for address data elements */
250 typedef struct tagDPADDRESS
254 } DPADDRESS, *LPDPADDRESS;
257 /* Used for specification of a communication port. Baud rate, stop bits and
258 * parity bits can be found in winbase.h. These are flow control constants only.
260 #define DPCPA_NOFLOW 0 /* no flow control */
261 #define DPCPA_XONXOFFFLOW 1 /* software flow control */
262 #define DPCPA_RTSFLOW 2 /* hardware flow control with RTS */
263 #define DPCPA_DTRFLOW 3 /* hardware flow control with DTR */
264 #define DPCPA_RTSDTRFLOW 4 /* hardware flow control with RTS and DTR */
266 typedef struct tagDPCOMPORTADDRESS
268 DWORD dwComPort; /* COM port to use (1-4) */
269 DWORD dwBaudRate; /* baud rate (100-256k) */
270 DWORD dwStopBits; /* no. stop bits (1-2) */
271 DWORD dwParity; /* parity (none, odd, even, mark) */
272 DWORD dwFlowControl; /* flow control (none, xon/xoff, rts, dtr) */
273 } DPCOMPORTADDRESS, *LPDPCOMPORTADDRESS;
277 /****************************************************************************
281 typedef struct tagDPLAPPINFO
284 GUID guidApplication;
292 } DPLAPPINFO, *LPDPLAPPINFO;
293 typedef const DPLAPPINFO *LPCDPLAPPINFO;
295 typedef struct DPCOMPOUNDADDRESSELEMENT
300 } DPCOMPOUNDADDRESSELEMENT, *LPDPCOMPOUNDADDRESSELEMENT;
301 typedef const DPCOMPOUNDADDRESSELEMENT *LPCDPCOMPOUNDADDRESSELEMENT;
303 typedef struct tagDPAPPLICATIONDESC
310 LPSTR lpszApplicationNameA;
311 LPWSTR lpszApplicationName;
314 GUID guidApplication;
324 LPSTR lpszCommandLineA;
325 LPWSTR lpszCommandLine;
336 LPSTR lpszCurrentDirectoryA;
337 LPWSTR lpszCurrentDirectory;
340 LPSTR lpszDescriptionA;
341 LPWSTR lpszDescriptionW;
343 } DPAPPLICATIONDESC, *LPDPAPPLICATIONDESC;
347 extern HRESULT WINAPI DirectPlayLobbyCreateW(LPGUID, LPDIRECTPLAYLOBBY*, IUnknown*, LPVOID, DWORD );
348 extern HRESULT WINAPI DirectPlayLobbyCreateA(LPGUID, LPDIRECTPLAYLOBBYA*, IUnknown*, LPVOID, DWORD );
352 typedef BOOL (CALLBACK *LPDPENUMADDRESSCALLBACK)(
353 REFGUID guidDataType,
358 typedef BOOL (CALLBACK *LPDPLENUMADDRESSTYPESCALLBACK)(
359 REFGUID guidDataType,
363 typedef BOOL (CALLBACK *LPDPLENUMLOCALAPPLICATIONSCALLBACK)(
364 LPCDPLAPPINFO lpAppInfo,
368 /*****************************************************************************
369 * IDirectPlayLobby and IDirectPlayLobbyA interface
371 #define ICOM_INTERFACE IDirectPlayLobby
372 #define IDirectPlayLobby_METHODS \
373 ICOM_METHOD3(HRESULT,Connect, DWORD,, LPDIRECTPLAY2*,, IUnknown*,) \
374 ICOM_METHOD6(HRESULT,CreateAddress, REFGUID,, REFGUID,, LPCVOID,, DWORD,, LPVOID,, LPDWORD,) \
375 ICOM_METHOD4(HRESULT,EnumAddress, LPDPENUMADDRESSCALLBACK,, LPCVOID,, DWORD,, LPVOID,) \
376 ICOM_METHOD4(HRESULT,EnumAddressTypes, LPDPLENUMADDRESSTYPESCALLBACK,, REFGUID,, LPVOID,, DWORD,) \
377 ICOM_METHOD3(HRESULT,EnumLocalApplications, LPDPLENUMLOCALAPPLICATIONSCALLBACK,, LPVOID,, DWORD,) \
378 ICOM_METHOD3(HRESULT,GetConnectionSettings, DWORD,, LPVOID,, LPDWORD,) \
379 ICOM_METHOD5(HRESULT,ReceiveLobbyMessage, DWORD,, DWORD,, LPDWORD,, LPVOID,, LPDWORD,) \
380 ICOM_METHOD4(HRESULT,RunApplication, DWORD,, LPDWORD,, LPDPLCONNECTION,, HANDLE,) \
381 ICOM_METHOD4(HRESULT,SendLobbyMessage, DWORD,, DWORD,, LPVOID,, DWORD,) \
382 ICOM_METHOD3(HRESULT,SetConnectionSettings, DWORD,, DWORD,, LPDPLCONNECTION,) \
383 ICOM_METHOD3(HRESULT,SetLobbyMessageEvent, DWORD,, DWORD,, HANDLE,)
384 #define IDirectPlayLobby_IMETHODS \
386 IDirectPlayLobby_METHODS
387 ICOM_DEFINE(IDirectPlayLobby,IUnknown)
388 #undef ICOM_INTERFACE
390 /*****************************************************************************
391 * IDirectPlayLobby2 and IDirectPlayLobby2A interface
393 #define ICOM_INTERFACE IDirectPlayLobby2
394 #define IDirectPlayLobby2_METHODS \
395 ICOM_METHOD4(HRESULT,CreateCompoundAddress, LPCDPCOMPOUNDADDRESSELEMENT,, DWORD,, LPVOID,, LPDWORD,)
396 #define IDirectPlayLobby2_IMETHODS \
397 IDirectPlayLobby_IMETHODS \
398 IDirectPlayLobby2_METHODS
399 ICOM_DEFINE(IDirectPlayLobby2,IDirectPlayLobby)
400 #undef ICOM_INTERFACE
402 /*****************************************************************************
403 * IDirectPlayLobby3 and IDirectPlayLobby3A interface
405 #define ICOM_INTERFACE IDirectPlayLobby3
406 #define IDirectPlayLobby3_METHODS \
407 ICOM_METHOD4( HRESULT, ConnectEx, DWORD,, REFIID,, LPVOID *,, IUnknown *,) \
408 ICOM_METHOD2( HRESULT, RegisterApplication, DWORD,, LPDPAPPLICATIONDESC, ) \
409 ICOM_METHOD2( HRESULT, UnregisterApplication, DWORD,, REFGUID, ) \
410 ICOM_METHOD1( HRESULT, WaitForConnectionSettings, DWORD, )
412 #define IDirectPlayLobby3_IMETHODS \
413 IDirectPlayLobby2_IMETHODS \
414 IDirectPlayLobby3_METHODS
415 ICOM_DEFINE(IDirectPlayLobby3,IDirectPlayLobby2)
416 #undef ICOM_INTERFACE
418 #define IDirectPlayLobby_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
419 #define IDirectPlayLobby_AddRef(p) ICOM_CALL (AddRef,p)
420 #define IDirectPlayLobby_Release(p) ICOM_CALL (Release,p)
421 #define IDirectPlayLobby_Connect(p,a,b,c) ICOM_CALL3(Connect,p,a,b,c)
422 #define IDirectPlayLobby_ConnectEx(p,a,b,c,d) ICOM_CALL4(ConnectEx,p,a,b,c,d)
423 #define IDirectPlayLobby_CreateAddress(p,a,b,c,d,e,f) ICOM_CALL6(CreateAddress,p,a,b,c,d,e,f)
424 #define IDirectPlayLobby_CreateCompoundAddress(p,a,b,c,d) ICOM_CALL4(CreateCompoundAddress,p,a,b,c,d)
425 #define IDirectPlayLobby_EnumAddress(p,a,b,c,d) ICOM_CALL4(EnumAddress,p,a,b,c,d)
426 #define IDirectPlayLobby_EnumAddressTypes(p,a,b,c,d) ICOM_CALL4(EnumAddressTypes,p,a,b,c,d)
427 #define IDirectPlayLobby_EnumLocalApplications(p,a,b,c) ICOM_CALL3(EnumLocalApplications,p,a,b,c)
428 #define IDirectPlayLobby_GetConnectionSettings(p,a,b,c) ICOM_CALL3(GetConnectionSettings,p,a,b,c)
429 #define IDirectPlayLobby_ReceiveLobbyMessage(p,a,b,c,d,e) ICOM_CALL5(ReceiveLobbyMessage,p,a,b,c,d,e)
430 #define IDirectPlayLobby_RegisterApplication(p,a,b) ICOM_CALL2(RegisterApplication,p,a,b)
431 #define IDirectPlayLobby_RunApplication(p,a,b,c,d) ICOM_CALL4(RunApplication,p,a,b,c,d)
432 #define IDirectPlayLobby_SendLobbyMessage(p,a,b,c,d) ICOM_CALL4(SendLobbyMessage,p,a,b,c,d)
433 #define IDirectPlayLobby_SetConnectionSettings(p,a,b,c) ICOM_CALL3(SetConnectionSettings,p,a,b,c)
434 #define IDirectPlayLobby_SetLobbyMessageEvent(p,a,b,c) ICOM_CALL3(SetLobbyMessageEvent,p,a,b,c)
435 #define IDirectPlayLobby_UnregisterApplication(p,a,b) ICOM_CALL2(UnregisterApplication,p,a,b)
436 #define IDirectPlayLobby_WaitForConnectionSettings(p,a) ICOM_CALL1(WaitForConnectionSettings,p,a)
438 /* Used for WaitForConnectionSettings */
439 #define DPLWAIT_CANCEL 0x00000001
443 #endif /* defined(__cplusplus) */
445 #endif /* __WINE_DPLOBBY_H */