dpnathlp.h revision 4b9d6701570cb98fd36e209314239d104ec584d3
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync/*
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * Copyright (C) 2006 Maarten Lankhorst
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync *
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * This library is free software; you can redistribute it and/or
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * modify it under the terms of the GNU Lesser General Public
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * License as published by the Free Software Foundation; either
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * version 2.1 of the License, or (at your option) any later version.
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync *
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * This library is distributed in the hope that it will be useful,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * but WITHOUT ANY WARRANTY; without even the implied warranty of
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * Lesser General Public License for more details.
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync *
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * You should have received a copy of the GNU Lesser General Public
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * License along with this library; if not, write to the Free Software
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync */
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync/*
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * other than GPL or LGPL is available it will apply instead, Oracle elects to use only
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * a choice of LGPL license versions is made available with the language indicating
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * that LGPLv2 or any later version may be used, or where a choice of which version
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync * of the LGPL is applied is otherwise unspecified.
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync */
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#ifndef __DPNATHLP_H__
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define __DPNATHLP_H__
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#ifdef __cplusplus
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncextern "C" {
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#endif
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncHRESULT DirectPlayNATHelpCreate(LPCGUID pIID, LPVOID *ppvInterface);
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncDEFINE_GUID(CLSID_DirectPlayNATHelpUPnP, 0xb9c2e9c4,0x68c1,0x4d42,0xa7,0xa1,0xe7,0x6a,0x26,0x98,0x2a,0xd6);
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncDEFINE_GUID(CLSID_DirectPlayNATHelpPAST, 0x963ab779,0x16a1,0x477c,0xa3,0x6d,0xcb,0x5e,0x71,0x19,0x38,0xf7);
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncDEFINE_GUID(IID_IDirectPlayNATHelp, 0x154940b6,0x2278,0x4a2f,0x91,0x01,0x9b,0xa9,0xf4,0x31,0xf6,0x03);
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHGETCAPS_UPDATESERVERSTATUS 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHREGISTERPORTS_TCP 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHREGISTERPORTS_FIXEDPORTS 0x02
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHREGISTERPORTS_SHAREDPORTS 0x04
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_TCP 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_FIXEDPORTS 0x02
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_SHAREDPORTS 0x04
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_LOCALFIREWALL 0x08
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_GATEWAY 0x10
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHADDRESSTYPE_GATEWAYISLOCAL 0x20
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHCAPSFLAG_LOCALFIREWALLPRESENT 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHCAPSFLAG_GATEWAYPRESENT 0x02
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHCAPSFLAG_GATEWAYISLOCAL 0x04
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHCAPSFLAG_PUBLICADDRESSAVAILABLE 0x08
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHCAPSFLAG_NOTALLSUPPORTACTIVENOTIFY 0x10
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHINITIALIZE_DISABLEGATEWAYSUPPORT 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHINITIALIZE_DISABLELOCALFIREWALLSUPPORT 0x02
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHQUERYADDRESS_TCP 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHQUERYADDRESS_CACHEFOUND 0x02
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHQUERYADDRESS_CACHENOTFOUND 0x04
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHQUERYADDRESS_CHECKFORPRIVATEBUTUNMAPPED 0x08
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHGETREGISTEREDADDRESSES_LOCALFIREWALLREMAPONLY 0x01
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define _DPNH_FACILITY_CODE 0x015
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define _DPNH_HRESULT_BASE 0xF000
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define MAKE_DPNHSUCCESS(code) \
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync MAKE_HRESULT(0, _DPNH_FACILITY_CODE, (code + _DPNH_HRESULT_BASE))
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define MAKE_DPNHFAILURE(code) \
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync MAKE_HRESULT(1, _DPNH_FACILITY_CODE, (code + _DPNH_HRESULT_BASE))
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNH_OK S_OK
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHSUCCESS_ADDRESSESCHANGED MAKE_DPNHSUCCESS(0x10)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_ALREADYINITIALIZED MAKE_DPNHFAILURE(0x10)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_BUFFERTOOSMALL MAKE_DPNHFAILURE(0x20)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_GENERIC E_FAIL
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_INVALIDFLAGS MAKE_DPNHFAILURE(0x30)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_INVALIDOBJECT MAKE_DPNHFAILURE(0x40)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_INVALIDPARAM E_INVALIDARG
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_INVALIDPOINTER E_POINTER
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_NOMAPPING MAKE_DPNHFAILURE(0x50)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_NOMAPPINGBUTPRIVATE MAKE_DPNHFAILURE(0x60)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_NOTINITIALIZED MAKE_DPNHFAILURE(0x70)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_OUTOFMEMORY E_OUTOFMEMORY
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_PORTALREADYREGISTERED MAKE_DPNHFAILURE(0x80)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_PORTUNAVAILABLE MAKE_DPNHFAILURE(0x90)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_REENTRANT MAKE_DPNHFAILURE(0x95)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_SERVERNOTAVAILABLE MAKE_DPNHFAILURE(0xA0)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define DPNHERR_UPDATESERVERSTATUS MAKE_DPNHFAILURE(0xC0)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsynctypedef DWORD_PTR DPNHHANDLE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsynctypedef DWORD_PTR *PDPNHHANDLE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsynctypedef struct _DPNHCAPS
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync{
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync DWORD dwSize;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync DWORD dwFlags;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync DWORD dwNumRegisteredPorts;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync DWORD dwMinLeaseTimeRemaining;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync DWORD dwRecommendedGetCapsInterval;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync} DPNHCAPS, *PDPNHCAPS;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define INTERFACE IDirectPlayNATHelp
889f8d29a8325ed741d1466074c5371910a1fd63vboxsyncDECLARE_INTERFACE_(IDirectPlayNATHelp,IUnknown)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync{
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync /*** IUnknown methods ***/
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(QueryInterface) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync REFIID riid,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync void** ppvObject) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD_(ULONG,AddRef) (THIS) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD_(ULONG,Release) (THIS) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync /*** IDirectPlayNATHelp functions ***/
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(Initialize) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(Close) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(GetCaps) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PDPNHCAPS pCaps,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(RegisterPorts) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PSOCKADDR aLocalAddresses,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwAddressSize,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwAddresses,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwTime,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PDPNHHANDLE phRegisteredPorts,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(GetRegisteredAddresses) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PDPNHHANDLE hRegisteredPorts,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PSOCKADDR paPublicAddresses,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD *dwAddressSize,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD *dwAddressFlags,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD *dwRemaining,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(DeregisterPorts)(THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DPNHHANDLE hRegPorts,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(QueryAddress) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PSOCKADDR pSource,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PSOCKADDR pQuery,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const PSOCKADDR pResponse,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const INT iAddresses,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(SetAlertEvent) (THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const HANDLE hEvent,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(SetAlertIOCompletionPort)(THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const HANDLE hIOCompletionPort,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwCompletion,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwMaxThreads,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync STDMETHOD(ExtendRegisteredPortsLease)(THIS_
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DPNHHANDLE hRegisteredPorts,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwLeaseTime,
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync const DWORD dwFlags) PURE;
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync};
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#undef INTERFACE
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#ifdef COBJMACROS
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_AddRef(p) (p)->lpVtbl->AddRef(p)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_Release(p) (p)->lpVtbl->Release(p)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_Initialize(p,a) (p)->lpVtbl->Initialize(p,a)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_Close(p,a) (p)->lpVtbl->Close(p,a)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_GetCaps(p,a,b) (p)->lpVtbl->GetCaps(p,a,b)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_RegisterPorts(p,a,b,c,d,e,f) (p)->lpVtbl->RegisterPorts(p,a,b,c,d,e,f)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_GetRegisteredAddresses(p,a,b,c,d,e,f) (p)->lpVtbl->GetRegisteredAddresses(p,a,b,c,d,e,f)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_DeregisterPorts(p,a,b) (p)->lpVtbl->DeregisterPorts(p,a,b)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_QueryAddress(p,a,b,c,d,e) (p)->lpVtbl->QueryAddress(p,a,b,c,d,e)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_SetAlertEvent(p,a,b) (p)->lpVtbl->SetAlertEvent(p,a,b)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_SetAlertIOCompletionPort(p,a,b,c,d) (p)->lpVtbl->SetAlertIOCompletionPort(p,a,b,c,d)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#define IDirectPlayNATHelp_ExtendRegisteredPortsLease(p,a,b,c) (p)->lpVtbl->SetAlertIOCompletionPort(p,a,b,c)
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#endif
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#ifdef __cplusplus
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync}
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#endif
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync#endif /* __DPNATHLP_H__ */
889f8d29a8325ed741d1466074c5371910a1fd63vboxsync