VirtualBox

source: vbox/trunk/src/VBox/NetworkServices/NetLib/utils.h@ 76690

Last change on this file since 76690 was 76576, checked in by vboxsync, 6 years ago

NetworkServices: scm header guard alignment.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.3 KB
Line 
1/* $Id: utils.h 76576 2019-01-01 06:05:25Z vboxsync $ */
2/** @file
3 * ComHostUtils.cpp
4 */
5
6/*
7 * Copyright (C) 2013-2019 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18/*******************************************************************************
19* Header Files *
20*******************************************************************************/
21
22#ifndef VBOX_INCLUDED_SRC_NetLib_utils_h
23#define VBOX_INCLUDED_SRC_NetLib_utils_h
24#ifndef RT_WITHOUT_PRAGMA_ONCE
25# pragma once
26#endif
27
28#include "cpp/utils.h"
29
30typedef ComPtr<IVirtualBox> ComVirtualBoxPtr;
31typedef ComPtr<IVirtualBoxClient> ComVirtualBoxClientPtr;
32typedef ComPtr<IDHCPServer> ComDhcpServerPtr;
33typedef ComPtr<IHost> ComHostPtr;
34typedef ComPtr<INATNetwork> ComNatPtr;
35typedef com::SafeArray<BSTR> ComBstrArray;
36
37typedef std::vector<RTNETADDRIPV4> AddressList;
38typedef std::map<RTNETADDRIPV4, int> AddressToOffsetMapping;
39
40
41inline bool isDhcpRequired(const ComNatPtr& nat)
42{
43 BOOL fNeedDhcpServer = false;
44 if (FAILED(nat->COMGETTER(NeedDhcpServer)(&fNeedDhcpServer)))
45 return false;
46
47 return RT_BOOL(fNeedDhcpServer);
48}
49
50
51inline int findDhcpServer(const ComVirtualBoxPtr& vbox, const std::string& name, ComDhcpServerPtr& dhcp)
52{
53 HRESULT hrc = vbox->FindDHCPServerByNetworkName(com::Bstr(name.c_str()).raw(),
54 dhcp.asOutParam());
55 AssertComRCReturn(hrc, VERR_NOT_FOUND);
56
57 return VINF_SUCCESS;
58}
59
60
61inline int findNatNetwork(const ComVirtualBoxPtr& vbox, const std::string& name, ComNatPtr& nat)
62{
63 HRESULT hrc = vbox->FindNATNetworkByName(com::Bstr(name.c_str()).raw(),
64 nat.asOutParam());
65
66 AssertComRCReturn(hrc, VERR_NOT_FOUND);
67
68 return VINF_SUCCESS;
69}
70
71
72inline RTNETADDRIPV4 networkid(const RTNETADDRIPV4& addr, const RTNETADDRIPV4& netmask)
73{
74 RTNETADDRIPV4 netid;
75 netid.u = addr.u & netmask.u;
76 return netid;
77}
78
79
80int localMappings(const ComNatPtr&, AddressToOffsetMapping&);
81int hostDnsSearchList(const ComHostPtr&, std::vector<std::string>&);
82int hostDnsDomain(const ComHostPtr&, std::string& domainStr);
83
84
85class NATNetworkEventAdapter
86{
87 public:
88 virtual HRESULT HandleEvent(VBoxEventType_T aEventType, IEvent *pEvent) = 0;
89};
90
91
92class NATNetworkListener
93{
94 public:
95 NATNetworkListener():m_pNAT(NULL){}
96
97 HRESULT init(NATNetworkEventAdapter *pNAT)
98 {
99 AssertPtrReturn(pNAT, E_INVALIDARG);
100
101 m_pNAT = pNAT;
102 return S_OK;
103 }
104
105 HRESULT init()
106 {
107 m_pNAT = NULL;
108 return S_OK;
109 }
110
111 void uninit() { m_pNAT = NULL; }
112
113 HRESULT HandleEvent(VBoxEventType_T aEventType, IEvent *pEvent)
114 {
115 if (m_pNAT)
116 return m_pNAT->HandleEvent(aEventType, pEvent);
117 else
118 return E_FAIL;
119 }
120
121 private:
122 NATNetworkEventAdapter *m_pNAT;
123};
124typedef ListenerImpl<NATNetworkListener, NATNetworkEventAdapter*> NATNetworkListenerImpl;
125
126# ifdef VBOX_WITH_XPCOM
127class NS_CLASSINFO_NAME(NATNetworkListenerImpl);
128# endif
129
130typedef ComPtr<NATNetworkListenerImpl> ComNatListenerPtr;
131typedef com::SafeArray<VBoxEventType_T> ComEventTypeArray;
132
133/* XXX: const is commented out because of compilation erro on Windows host, but it's intended that this function
134 isn't modify event type array */
135int createNatListener(ComNatListenerPtr& listener, const ComVirtualBoxPtr& vboxptr,
136 NATNetworkEventAdapter *adapter, /* const */ ComEventTypeArray& events);
137int destroyNatListener(ComNatListenerPtr& listener, const ComVirtualBoxPtr& vboxptr);
138int createClientListener(ComNatListenerPtr& listener, const ComVirtualBoxClientPtr& vboxclientptr,
139 NATNetworkEventAdapter *adapter, /* const */ ComEventTypeArray& events);
140int destroyClientListener(ComNatListenerPtr& listener, const ComVirtualBoxClientPtr& vboxclientptr);
141
142#endif /* !VBOX_INCLUDED_SRC_NetLib_utils_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette