VirtualBox

source: vbox/trunk/src/VBox/NetworkServices/NetLib/VBoxNetBaseService.h@ 67954

Last change on this file since 67954 was 63267, checked in by vboxsync, 8 years ago

NetworkServices: warnings

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1/* $Id: VBoxNetBaseService.h 63267 2016-08-10 13:34:15Z vboxsync $ */
2/** @file
3 * VBoxNetUDP - IntNet Client Library.
4 */
5
6/*
7 * Copyright (C) 2009-2016 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#ifndef ___VBoxNetBaseService_h___
19#define ___VBoxNetBaseService_h___
20
21#include <iprt/critsect.h>
22
23
24class VBoxNetHlpUDPService
25{
26public:
27virtual int hlpUDPBroadcast(unsigned uSrcPort, unsigned uDstPort,
28 void const *pvData, size_t cbData) const = 0;
29};
30
31
32class VBoxNetLockee
33{
34public:
35 virtual int syncEnter() = 0;
36 virtual int syncLeave() = 0;
37};
38
39
40class VBoxNetALock
41{
42public:
43 VBoxNetALock(VBoxNetLockee *a_lck):m_lck(a_lck)
44 {
45 if (m_lck)
46 m_lck->syncEnter();
47 }
48
49 ~VBoxNetALock()
50 {
51 if (m_lck)
52 m_lck->syncLeave();
53 }
54
55private:
56 VBoxNetLockee *m_lck;
57};
58
59# ifndef BASE_SERVICES_ONLY
60class VBoxNetBaseService: public VBoxNetHlpUDPService, public VBoxNetLockee
61{
62public:
63 VBoxNetBaseService(const std::string& aName, const std::string& aNetworkName);
64 virtual ~VBoxNetBaseService();
65 int parseArgs(int argc, char **argv);
66 int tryGoOnline(void);
67 void shutdown(void);
68 int syncEnter();
69 int syncLeave();
70 int waitForIntNetEvent(int cMillis);
71 int abortWait();
72 int sendBufferOnWire(PCINTNETSEG paSegs, size_t cSegs, size_t cbBuffer);
73 void flushWire();
74
75 virtual int hlpUDPBroadcast(unsigned uSrcPort, unsigned uDstPort,
76 void const *pvData, size_t cbData) const;
77 virtual void usage(void) = 0;
78 virtual int parseOpt(int rc, const RTGETOPTUNION& getOptVal) = 0;
79 virtual int processFrame(void *, size_t) = 0;
80 virtual int processGSO(PCPDMNETWORKGSO, size_t) = 0;
81 virtual int processUDP(void *, size_t) = 0;
82
83
84 virtual int init(void);
85 virtual int run(void);
86 virtual bool isMainNeeded() const;
87
88protected:
89 const std::string getServiceName() const;
90 void setServiceName(const std::string&);
91
92 const std::string getNetworkName() const;
93 void setNetworkName(const std::string&);
94
95 const RTMAC getMacAddress() const;
96 void setMacAddress(const RTMAC&);
97
98 const RTNETADDRIPV4 getIpv4Address() const;
99 void setIpv4Address(const RTNETADDRIPV4&);
100
101 const RTNETADDRIPV4 getIpv4Netmask() const;
102 void setIpv4Netmask(const RTNETADDRIPV4&);
103
104 uint32_t getSendBufSize() const;
105 void setSendBufSize(uint32_t);
106
107 uint32_t getRecvBufSize() const;
108 void setRecvBufSize(uint32_t);
109
110 int32_t getVerbosityLevel() const;
111 void setVerbosityLevel(int32_t);
112
113 void addCommandLineOption(const PRTGETOPTDEF);
114
115 /**
116 * Print debug message depending on the m_cVerbosity level.
117 *
118 * @param iMinLevel The minimum m_cVerbosity level for this message.
119 * @param fMsg Whether to dump parts for the current DHCP message.
120 * @param pszFmt The message format string.
121 * @param ... Optional arguments.
122 */
123 void debugPrint(int32_t iMinLevel, bool fMsg, const char *pszFmt, ...) const;
124 virtual void debugPrintV(int32_t iMinLevel, bool fMsg, const char *pszFmt, va_list va) const;
125
126 private:
127 void doReceiveLoop();
128
129 /** starts receiving thread and enter event polling loop. */
130 int startReceiveThreadAndEnterEventLoop();
131
132 protected:
133 /* VirtualBox instance */
134 ComPtr<IVirtualBox> virtualbox;
135 ComPtr<IVirtualBoxClient> virtualboxClient;
136
137 private:
138 struct Data;
139 Data *m;
140
141 private:
142 PRTGETOPTDEF getOptionsPtr();
143};
144# endif
145#endif
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