VirtualBox

source: vbox/trunk/src/VBox/Main/include/DHCPServerImpl.h@ 67954

Last change on this file since 67954 was 66938, checked in by vboxsync, 7 years ago

Main/VirtualBox+DHCPServer+GuestOSType: lots of redundant Bstr/Utf8Str conversions removed, less Bstr use in general avoiding the need for conversion, plus some cleanup of VirtualBox::i_findGuestOSType which is now used consistently

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.4 KB
Line 
1/* $Id: DHCPServerImpl.h 66938 2017-05-17 16:09:58Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2006-2016 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#ifndef ____H_H_DHCPSERVERIMPL
21#define ____H_H_DHCPSERVERIMPL
22
23#include "DHCPServerWrap.h"
24
25namespace settings
26{
27 struct DHCPServer;
28 struct DhcpOptValue;
29 typedef std::map<DhcpOpt_T, DhcpOptValue> DhcpOptionMap;
30}
31
32
33#ifdef VBOX_WITH_HOSTNETIF_API
34struct NETIFINFO;
35#endif
36
37#ifdef RT_OS_WINDOWS
38# define DHCP_EXECUTABLE_NAME "VBoxNetDHCP.exe"
39#else
40# define DHCP_EXECUTABLE_NAME "VBoxNetDHCP"
41#endif
42
43class DHCPServerRunner: public NetworkServiceRunner
44{
45public:
46 DHCPServerRunner():NetworkServiceRunner(DHCP_EXECUTABLE_NAME){}
47 virtual ~DHCPServerRunner(){};
48
49 static const std::string kDsrKeyGateway;
50 static const std::string kDsrKeyLowerIp;
51 static const std::string kDsrKeyUpperIp;
52};
53
54/**
55 * for server configuration needs, it's perhaps better to use (VM,slot) pair
56 * (vm-name, slot) <----> (MAC)
57 *
58 * but for client configuration, when server will have MACs at hand, it'd be
59 * easier to requiest options by MAC.
60 * (MAC) <----> (option-list)
61 *
62 * Doubts: What should be done if MAC changed for (vm-name, slot), when syncing should?
63 * XML: serialization of dependecy (DHCP options) - (VM,slot) shouldn't be done via MAC in
64 * the middle.
65 */
66
67class ATL_NO_VTABLE DHCPServer :
68 public DHCPServerWrap
69{
70public:
71
72 DECLARE_EMPTY_CTOR_DTOR(DHCPServer)
73
74 HRESULT FinalConstruct();
75 void FinalRelease();
76
77 HRESULT init(VirtualBox *aVirtualBox,
78 const com::Utf8Str &aName);
79 HRESULT init(VirtualBox *aVirtualBox,
80 const settings::DHCPServer &data);
81 void uninit();
82
83 // Public internal methids.
84 HRESULT i_saveSettings(settings::DHCPServer &data);
85 settings::DhcpOptionMap &i_findOptMapByVmNameSlot(const com::Utf8Str &aVmName,
86 LONG Slot);
87
88private:
89 HRESULT encodeOption(com::Utf8Str &aEncoded,
90 uint32_t aOptCode, const settings::DhcpOptValue &aOptValue);
91 int addOption(settings::DhcpOptionMap &aMap,
92 DhcpOpt_T aOption, const com::Utf8Str &aValue);
93
94 // wrapped IDHCPServer properties
95 HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
96 HRESULT getEnabled(BOOL *aEnabled);
97 HRESULT setEnabled(BOOL aEnabled);
98 HRESULT getIPAddress(com::Utf8Str &aIPAddress);
99 HRESULT getNetworkMask(com::Utf8Str &aNetworkMask);
100 HRESULT getNetworkName(com::Utf8Str &aName);
101 HRESULT getLowerIP(com::Utf8Str &aIPAddress);
102 HRESULT getUpperIP(com::Utf8Str &aIPAddress);
103 HRESULT getGlobalOptions(std::vector<com::Utf8Str> &aGlobalOptions);
104 HRESULT getVmConfigs(std::vector<com::Utf8Str> &aVmConfigs);
105 HRESULT getMacOptions(const com::Utf8Str &aMAC, std::vector<com::Utf8Str> &aValues);
106 HRESULT setConfiguration(const com::Utf8Str &aIPAddress,
107 const com::Utf8Str &aNetworkMask,
108 const com::Utf8Str &aFromIPAddress,
109 const com::Utf8Str &aToIPAddress);
110 HRESULT getVmSlotOptions(const com::Utf8Str &aVmName,
111 LONG aSlot,
112 std::vector<com::Utf8Str> &aValues);
113
114 // Wrapped IDHCPServer Methods
115 HRESULT addGlobalOption(DhcpOpt_T aOption,
116 const com::Utf8Str &aValue);
117 HRESULT addVmSlotOption(const com::Utf8Str &aVmName,
118 LONG aSlot,
119 DhcpOpt_T aOption,
120 const com::Utf8Str &aValue);
121 HRESULT removeVmSlotOptions(const com::Utf8Str &aVmName,
122 LONG aSlot);
123 HRESULT start(const com::Utf8Str &aNetworkName,
124 const com::Utf8Str &aTrunkName,
125 const com::Utf8Str &aTrunkType);
126 HRESULT stop();
127
128 struct Data;
129 Data *m;
130 /** weak VirtualBox parent */
131 VirtualBox *const mVirtualBox;
132 const Utf8Str mName;
133};
134
135#endif // ____H_H_DHCPSERVERIMPL
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