Microsoft/xbox-kernel
Microsoft/xbox-kernel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
master
xbox-kernel/private/inc/dpsp8p.h

569 lines
21 KiB
C
Raw Permalink Normal View History

First commit
2001-01-01 00:00:00 +01:00
/*==========================================================================;
*
* Copyright (C) 1998-2000 Microsoft Corporation. All Rights Reserved.
*
* File: DPSP8.h
* Content: Service provider include file
* History:
* Date By Reason
* ============
* 10/12/98 jwo created
* 03/22/2000 jtk Changed interface names
* 05/16/2000 jtk Derived from DNSP.h
***************************************************************************/
#ifndef __DIRECT_PLAY_SERVICE_PROVIDER_8__
#define __DIRECT_PLAY_SERVICE_PROVIDER_8__
#include <dplay8p.h>
#include <dpaddrp.h>
#include <xobjbase.h>
#ifdef __cplusplus
extern "C" {
#endif
//**********************************************************************
// Constant definitions
//**********************************************************************
//
// Enumerated values for service provider events
//
typedef enum _SP_EVENT_TYPE
{
SPEV_UNKNOWN = 0,
SPEV_DATA,
SPEV_CONNECT,
SPEV_DISCONNECT,
SPEV_ENUMQUERY,
SPEV_QUERYRESPONSE,
SPEV_LISTENSTATUS,
SPEV_LISTENADDRESSINFO,
SPEV_ENUMADDRESSINFO,
SPEV_CONNECTADDRESSINFO
} SP_EVENT_TYPE;
/* Flags */
#define DPNSPF_OKTOSHOWSTATUS 0x00000001 // OK for SP to show status windows
#define DPNSPF_RELIABLE 0x00000004 // reliable delivery/connection
#define DPNSPF_UNRELIABLE 0x00000008 // unreliable delivery/connection
#define DPNSPF_NOBROADCASTFALLBACK 0x00000010 // don't allow SP to fallback to broadcast with insufficient information
// (only if the SP supports broadcast)
#define DPNSPF_BINDLISTENTOGATEWAY 0x00000020 // when performing a 'listen' attempt create a mapping between the local
// 'port' to the same 'port' on the network 'gateway'.
//
// flags for joining groups
//
#define SP_ADD_TO_MULTICAST_GROUP_RECEIVE 0x00000001
#define SP_ADD_TO_MULTICAST_GROUP_SEND 0x00000002
//
// flags for getting address information
//
typedef enum
{
SP_GET_ADDRESS_INFO_LOCAL_ADAPTER = 0x00000001, // local adapter address
SP_GET_ADDRESS_INFO_LISTEN_HOST_ADDRESSES, // local adapter address (in 'host' form to be passed to connect/enum)
SP_GET_ADDRESS_INFO_LOCAL_HOST_PUBLIC_ADDRESS, // local adapter address as mapped on the 'gateway' (in 'host' form for connect/enum)
SP_GET_ADDRESS_INFO_REMOTE_HOST // address of other end of an endpoint (in 'host' form to be passed to connect/enum)
} SP_GET_ADDRESS_INFO_FLAGS;
//**********************************************************************
// Macro definitions
//**********************************************************************
//**********************************************************************
// Structure definitions
//**********************************************************************
//
// data received from the SP
//
typedef struct _SPRECEIVEDBUFFER
{
_SPRECEIVEDBUFFER *pNext; // link to next item in list
DWORD dwProtocolData; // reserved for protocol
PVOID pServiceProviderDescriptor; // reserved for protocol
BUFFERDESC BufferDesc; // received buffer description
} SPRECEIVEDBUFFER, *PSPRECEIVEDBUFFER;
//
// connect indication
//
typedef struct _SPIE_CONNECT
{
HANDLE hEndpoint; // handle of the new endpoint
void *pEndpointContext; // user context associated with this endpoint
void *pCommandContext; // user context for associated command
} SPIE_CONNECT, *PSPIE_CONNECT;
//
// disconnect indication
//
typedef struct _SPIE_DISCONNECT
{
HANDLE hEndpoint; // handle of endpoint being disconnected
void *pEndpointContext; // user context associated with this endpoint
} SPIE_DISCONNECT, *PSPIE_DISCONNECT;
//
// user data indication
//
typedef struct _SPIE_DATA
{
HANDLE hEndpoint; // EP from which this data was received
void *pEndpointContext; // user context associated with this endpoint
SPRECEIVEDBUFFER *pReceivedData; // pointer to received data
} SPIE_DATA, *PSPIE_DATA;
//
// enum data indication
//
typedef struct _SPIE_QUERY
{
IDirectPlay8Address *pAddressSender; // address from which the query came (may be NULL)
IDirectPlay8Address *pAddressDevice; // address of device on which query was received
SPRECEIVEDBUFFER *pReceivedData; // pointer to received data
void *pUserContext; // user context passed into listen command
} SPIE_QUERY, *PSPIE_QUERY;
//
// enum response data indication
//
typedef struct _SPIE_QUERYRESPONSE
{
IDirectPlay8Address *pAddressSender; // address from which the query came (may be NULL)
IDirectPlay8Address *pAddressDevice; // address of device on which query response was received
SPRECEIVEDBUFFER *pReceivedData; // pointer to received data
DWORD dwRoundTripTime; // round trip time for enum (milliseconds)
void *pUserContext; // user context passed into enum command
} SPIE_QUERYRESPONSE, *PSPIE_QUERYRESPONSE;
//
// event sent to indicate status of 'listen' on an adapter
//
typedef struct _SPIE_LISTENSTATUS
{
GUID ListenAdapter; // adapter GUID
HRESULT hResult; // result of listen
HANDLE hCommand; // handle of associated command
void *pUserContext; // user context passed into command
HANDLE hEndpoint; // handle of endpoint associated with this listen
} SPIE_LISTENSTATUS, *PSPIE_LISTENSTATUS;
//
// event sent to indicate address info for 'listen' on an adapter
//
typedef struct _SPIE_LISTENADDRESSINFO
{
IDirectPlay8Address *pDeviceAddress; // device address used to complete this command
HRESULT hCommandStatus; // command status
void *pCommandContext; // command context
} SPIE_LISTENADDRESSINFO, *PSPIE_LISTENADDRESSINFO;
//
// event sent to indicate address info for 'enum' on an adapter
//
typedef struct _SPIE_ENUMADDRESSINFO
{
IDirectPlay8Address *pHostAddress; // host address used to complete this command
IDirectPlay8Address *pDeviceAddress; // device address used to complete this command
HRESULT hCommandStatus; // command status
void *pCommandContext; // command context
} SPIE_ENUMADDRESSINFO, *PSPIE_ENUMADDRESSINFO;
//
// event sent to indicate status of 'connect' on an adapter
//
typedef struct _SPIE_CONNECTADDRESSINFO
{
IDirectPlay8Address *pHostAddress; // host address used to complete this command
IDirectPlay8Address *pDeviceAddress; // device address used to complete this command
HRESULT hCommandStatus; // command status
void *pCommandContext; // command context
} SPIE_CONNECTADDRESSINFO, *PSPIE_CONNECTADDRESSINFO;
//
// data passed through the service provider interface
//
typedef struct IDP8SPCallback FAR *PDP8SPCALLBACK;
typedef struct IDP8SPCallback IDP8SPCallback;
// Love to use SPINITDATA, but the old DPlay already took it, and compilers
// don't like namespace collisions for some strange reason.
typedef struct _SPINITIALIZEDATA
{
IDP8SPCallback *pIDP; // pointer to callback interface
DWORD dwFlags; // flags
} SPINITIALIZEDATA, *PSPINITIALIZEDATA;
typedef struct _SPGETCAPSDATA
{
DWORD dwSize; // size of this structure
HANDLE hEndpoint; // Handle of endpoint to check. If this parameter
// is NULL, the best-case capabilities of the SP are
// returned.
DWORD dwUserFrameSize; // Maximum data payload allowed in an outgoing
// message from this SP. It is the SP's responsibility
// to account for any extra header information it's
// going to attach when sending a message, and for any
// underlying protocol overhead (IP packet headers).
DWORD dwEnumFrameSize; // maximum payload for an enum query (NOT ENUM RESPONSE!)
DWORD dwLocalLinkSpeed; // speed of link in bits per second
DWORD dwIOThreadCount; // count of threads in operation by this SP
DWORD dwDefaultEnumRetryCount; // default retry count
DWORD dwDefaultEnumRetryInterval; // default retry interval
DWORD dwDefaultEnumTimeout; // default timeout
DWORD dwFlags; // SP flags
DWORD dwBuffersPerThread; // buffers per thread
DWORD dwSystemBufferSize; // system buffer size
} SPGETCAPSDATA, *PSPGETCAPSDATA;
typedef struct _SPSETCAPSDATA
{
DWORD dwSize; // size of this structure
DWORD dwIOThreadCount; // number of threads in operation by this SP
DWORD dwBuffersPerThread; // buffers per thread
DWORD dwSystemBufferSize; // system buffer size
} SPSETCAPSDATA, *PSPSETCAPSDATA;
typedef struct _SPGETADDRESSINFODATA
{
HANDLE hEndpoint; // handle of endpoint to check
IDirectPlay8Address *pAddress; // pointer to output address
SP_GET_ADDRESS_INFO_FLAGS Flags; // flags
} SPGETADDRESSINFODATA, *PSPGETADDRESSINFODATA;
typedef struct _SPENUMQUERYDATA
{
IDirectPlay8Address *pAddressHost; // address to which to send
IDirectPlay8Address *pAddressDeviceInfo; // device to enumerate on
BUFFERDESC *pBuffers; // pointer to buffers to send
DWORD dwBufferCount; // count of buffers to send
DWORD dwTimeout; // how long to wait for replies (0 means infinite)
DWORD dwRetryCount; // how many times to send it (0 means infinite)
DWORD dwRetryInterval; // how long to wait between retries
DWORD dwFlags;
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPENUMQUERYDATA, *PSPENUMQUERYDATA;
typedef struct _SPENUMRESPONDDATA
{
SPIE_QUERY *pQuery; // pointer to the query indication to which you're responding
BUFFERDESC *pBuffers;
DWORD dwBufferCount;
DWORD dwFlags; // must be zero!
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPENUMRESPONDDATA, *PSPENUMRESPONDDATA;
typedef struct _SPCONNECTDATA
{
IDirectPlay8Address *pAddressHost; // address to which to connect
IDirectPlay8Address *pAddressDeviceInfo; // address to which to connect
DWORD dwTimeout; // how long to wait before failing
DWORD dwFlags;
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPCONNECTDATA, *PSPCONNECTDATA;
typedef struct _SPDISCONNECTDATA
{
HANDLE hEndpoint; // handle to the endpoint to disconnect
DWORD dwFlags; // must be zero!
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPDISCONNECTDATA, *PSPDISCONNECTDATA;
typedef struct _SPLISTENDATA
{
IDirectPlay8Address *pAddressDeviceInfo; // address to listen on
DWORD dwFlags;
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPLISTENDATA, *PSPLISTENDATA;
typedef struct _SPSENDDATA
{
HANDLE hEndpoint; // handle of endpoint on which to send the data
BUFFERDESC *pBuffers; // data to send
DWORD dwBufferCount; // count of buffers to send
DWORD dwFlags; // send flags
void *pvContext; // caller's toy, returned in the completion indication
HANDLE hCommand; // Returned
DWORD dwCommandDescriptor; // Returned
} SPSENDDATA, *PSPSENDDATA;
typedef struct _SPCREATEGROUPDATA
{
IDirectPlay8Address *pGroupAddress; // pointer to group address (may be NULL)
const GUID *pAdapterGuid; // pointer to GUID of adapter to create group with
void *pGroupData; // pointer to store protocol-specific group data (to be propagated to other machines)
DWORD dwGroupDataSize; // size of protocol specific group data
DWORD dwFlags; // flags (must be zero)
} SPCREATEGROUPDATA, *PSPCREATEGROUPDATA;
typedef struct _SPADDTOGROUPDATA
{
const GUID *pAdapterGuid; // pointer to GUID of adapter used to join the group
const void *pGroupData; // pointer to group data
DWORD dwGroupDataSize; // size of group data
HANDLE hMulticastEndpoint; // handle of multicast endpoint associated with group (returned)
DWORD dwFlags; // flags (must not be zero)
} SPADDTOGROUPDATA, *PSPADDTOGROUPDATA;
typedef struct _SPREMOVEFROMGROUPDATA
{
HANDLE hEndpoint; // handle of group endpoint
const void *pGroupData; // pointer to protocol-specific group data
DWORD dwGroupDataSize; // size of protocol specific group data
DWORD dwFlags; // flags (must be zero)
} SPREMOVEFROMGROUPDATA, *PSPREMOVEFROMGROUPDATA;
typedef struct _SPDELETEGROUPDATA
{
const GUID *pAdapterGuid; // pointer to GUID of adapter to delete group with
const void *pGroupData; // protocol-specific group data
DWORD dwGroupDataSize; // size of protocol specific group data
DWORD dwFlags;
} SPDELETEGROUPDATA, *PSPDELETEGROUPDATA;
typedef struct _SPISAPPLICATIONSUPPORTEDDATA
{
const GUID *pApplicationGuid;
DWORD dwFlags;
} SPISAPPLICATIONSUPPORTEDDATA, *PSPISAPPLICATIONSUPPORTEDDATA;
typedef struct _SPENUMADAPTERSDATA
{
DPN_SERVICE_PROVIDER_INFO *pAdapterData;
DWORD dwAdapterDataSize;
DWORD dwAdapterCount;
DWORD dwFlags;
} SPENUMADAPTERSDATA, *PSPENUMADAPTERSDATA;
typedef struct _SPPROXYENUMQUERYDATA
{
DWORD dwFlags;
SPIE_QUERY *pIncomingQueryData;
IDirectPlay8Address *pDestinationAdapter;
} SPPROXYENUMQUERYDATA, *PSPPROXYENUMQUERYDATA;
//**********************************************************************
// Variable definitions
//**********************************************************************
//**********************************************************************
// Function prototypes
//**********************************************************************
//**********************************************************************
// Function definitions
//**********************************************************************
/****************************************************************************
* IDirectPlay8SP Interface- SP's call back into DPLAY via this interface
****************************************************************************/
#undef INTERFACE
#define INTERFACE IDP8SPCallback
DECLARE_INTERFACE_( IDP8SPCallback, IUnknown )
{
/*** IUnknown methods ***/
STDMETHOD(QueryInterface) (THIS_ REFIID riid, LPVOID * ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*** IDirectPlay8SP methods ***/
STDMETHOD(IndicateEvent) (THIS_ SP_EVENT_TYPE,LPVOID) PURE;
STDMETHOD(CommandComplete) (THIS_ HANDLE,HRESULT,LPVOID) PURE;
};
/****************************************************************************
* IDirectPlay8SP interface macros
****************************************************************************/
#if !defined(__cplusplus) || defined(CINTERFACE)
#define IDP8SPCallback_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
#define IDP8SPCallback_AddRef(p) (p)->lpVtbl->AddRef(p)
#define IDP8SPCallback_Release(p) (p)->lpVtbl->Release(p)
#define IDP8SPCallback_IndicateEvent(p,a,b) (p)->lpVtbl->IndicateEvent(p,a,b)
#define IDP8SPCallback_CommandComplete(p,a,b,c) (p)->lpVtbl->CommandComplete(p,a,b,c)
#else /* C++ */
#define IDP8SPCallback_QueryInterface(p,a,b) (p)->QueryInterface(a,b)
#define IDP8SPCallback_AddRef(p) (p)->AddRef()
#define IDP8SPCallback_Release(p) (p)->Release()
#define IDP8SPCallback_IndicateEvent(p,a,b) (p)->IndicateEvent(a,b)
#define IDP8SPCallback_CommandComplete(p,a,b,c) (p)->CommandComplete(a,b,c)
#endif
/****************************************************************************
* IDirectPlay8ServiceProvider Interface
****************************************************************************/
#undef INTERFACE
#define INTERFACE IDP8ServiceProvider
DECLARE_INTERFACE_( IDP8ServiceProvider, IUnknown )
{
/*** IUnknown methods ***/
STDMETHOD(QueryInterface) (THIS_ REFIID riid, LPVOID * ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*** IDP8ServiceProvider methods ***/
STDMETHOD(Initialize) (THIS_ PSPINITIALIZEDATA) PURE;
STDMETHOD(Close) (THIS) PURE;
STDMETHOD(Connect) (THIS_ PSPCONNECTDATA) PURE;
STDMETHOD(Disconnect) (THIS_ PSPDISCONNECTDATA) PURE;
STDMETHOD(Listen) (THIS_ PSPLISTENDATA) PURE;
STDMETHOD(SendData) (THIS_ PSPSENDDATA) PURE;
STDMETHOD(EnumQuery) (THIS_ PSPENUMQUERYDATA) PURE;
STDMETHOD(EnumRespond) (THIS_ PSPENUMRESPONDDATA) PURE;
STDMETHOD(CancelCommand) (THIS_ HANDLE, DWORD) PURE;
STDMETHOD(CreateGroup) (THIS_ PSPCREATEGROUPDATA) PURE;
STDMETHOD(DeleteGroup) (THIS_ PSPDELETEGROUPDATA) PURE;
STDMETHOD(AddToGroup) (THIS_ PSPADDTOGROUPDATA) PURE;
STDMETHOD(RemoveFromGroup) (THIS_ PSPREMOVEFROMGROUPDATA) PURE;
STDMETHOD(GetCaps) (THIS_ PSPGETCAPSDATA) PURE;
STDMETHOD(SetCaps) (THIS_ PSPSETCAPSDATA) PURE;
STDMETHOD(ReturnReceiveBuffers) (THIS_ PSPRECEIVEDBUFFER) PURE;
STDMETHOD(GetAddressInfo) (THIS_ PSPGETADDRESSINFODATA) PURE;
STDMETHOD(IsApplicationSupported) (THIS_ PSPISAPPLICATIONSUPPORTEDDATA) PURE;
STDMETHOD(ProxyEnumQuery) (THIS_ PSPPROXYENUMQUERYDATA) PURE;
};
/****************************************************************************
* IDDP8ServiceProvider interface macros
****************************************************************************/
#if !defined(__cplusplus) || defined(CINTERFACE)
#define IDP8ServiceProvider_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
#define IDP8ServiceProvider_AddRef(p) (p)->lpVtbl->AddRef(p)
#define IDP8ServiceProvider_Release(p) (p)->lpVtbl->Release(p)
#define IDP8ServiceProvider_Initialize(p,a) (p)->lpVtbl->Initialize(p,a)
#define IDP8ServiceProvider_Connect(p,a) (p)->lpVtbl->Connect(p,a)
#define IDP8ServiceProvider_Disconnect(p,a) (p)->lpVtbl->Disconnect(p,a)
#define IDP8ServiceProvider_Listen(p,a) (p)->lpVtbl->Listen(p,a)
#define IDP8ServiceProvider_SendData(p,a) (p)->lpVtbl->SendData(p,a)
#define IDP8ServiceProvider_EnumQuery(p,a) (p)->lpVtbl->EnumQuery(p,a)
#define IDP8ServiceProvider_EnumRespond(p,a) (p)->lpVtbl->EnumRespond(p,a)
#define IDP8ServiceProvider_CancelCommand(p,a,b) (p)->lpVtbl->CancelCommand(p,a,b)
#define IDP8ServiceProvider_Close(p) (p)->lpVtbl->Close(p)
#define IDP8ServiceProvider_CreateGroup(p,a) (p)->lpVtbl->CreateGroup(p,a)
#define IDP8ServiceProvider_DeleteGroup(p,a) (p)->lpVtbl->DeleteGroup(p,a)
#define IDP8ServiceProvider_AddToGroup(p,a) (p)->lpVtbl->AddToGroup(p,a)
#define IDP8ServiceProvider_RemoveFromGroup(p,a) (p)->lpVtbl->RemoveFromGroup(p,a)
#define IDP8ServiceProvider_GetCaps(p,a) (p)->lpVtbl->GetCaps(p,a)
#define IDP8ServiceProvider_SetCaps(p,a) (p)->lpVtbl->SetCaps(p,a)
#define IDP8ServiceProvider_ReturnReceiveBuffers(p,a) (p)->lpVtbl->ReturnReceiveBuffers(p,a)
#define IDP8ServiceProvider_GetAddressInfo(p,a) (p)->lpVtbl->GetAddressInfo(p,a)
#define IDP8ServiceProvider_IsApplicationSupported(p,a) (p)->lpVtbl->IsApplicationSupported(p,a)
#define IDP8ServiceProvider_ProxyEnumQuery(p,a) (p)->lpVtbl->ProxyEnumQuery(p,a)
#else /* C++ */
#define IDP8ServiceProvider_QueryInterface(p,a,b) (p)->QueryInterface(a,b)
#define IDP8ServiceProvider_AddRef(p) (p)->AddRef()
#define IDP8ServiceProvider_Release(p) (p)->Release()
#define IDP8ServiceProvider_Initialize(p,a) (p)->Initialize(a)
#define IDP8ServiceProvider_Connect(p,a) (p)->Connect(a)
#define IDP8ServiceProvider_Disconnect(p,a) (p)->Disconnect(a)
#define IDP8ServiceProvider_Listen(p,a) (p)->Listen(a)
#define IDP8ServiceProvider_SendData(p,a) (p)->SendData(a)
#define IDP8ServiceProvider_EnumQuery(p,a) (p)->EnumQuery(a)
#define IDP8ServiceProvider_EnumRespond(p,a) (p)->EnumRespond(a)
#define IDP8ServiceProvider_CancelCommand(p,a,b) (p)->CancelCommand(a,b)
#define IDP8ServiceProvider_Close(p) (p)->Close()
#define IDP8ServiceProvider_CreateGroup(p,a) (p)->CreateGroup(a)
#define IDP8ServiceProvider_DeleteGroup(p,a) (p)->DeleteGroup(a)
#define IDP8ServiceProvider_AddToGroup(p,a) (p)->AddToGroup(a)
#define IDP8ServiceProvider_RemoveFromGroup(p,a) (p)->RemoveFromGroup(a)
#define IDP8ServiceProvider_GetCaps(p,a) (p)->GetCaps(a)
#define IDP8ServiceProvider_SetCaps(p,a) (p)->SetCaps(a)
#define IDP8ServiceProvider_ReturnReceiveBuffers(p,a) (p)->ReturnReceiveBuffers(a)
#define IDP8ServiceProvider_GetAddressInfo(p,a) (p)->GetAddressInfo(a)
#define IDP8ServiceProvider_IsApplicationSupported(p,a) (p)->IsApplicationSupported(a)
#define IDP8ServiceProvider_ProxyEnumQuery(p,a) (p)->ProxyEnumQuery(a)
#endif // C++
#ifdef __cplusplus
};
#endif
#endif // __DIRECT_PLAY_SERVICE_PROVIDER_8__
Reference in New Issue Copy Permalink