VirtualBox

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

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

Main: doxygen fixes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.0 KB
Line 
1/* $Id: BandwidthGroupImpl.h 65088 2017-01-03 20:52:49Z vboxsync $ */
2/** @file
3 *
4 * VirtualBox COM class implementation
5 */
6
7/*
8 * Copyright (C) 2006-2016 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19#ifndef ____H_BANDWIDTHGROUPIMPL
20#define ____H_BANDWIDTHGROUPIMPL
21
22#include <VBox/settings.h>
23#include "BandwidthControlImpl.h"
24#include "BandwidthGroupWrap.h"
25
26
27class ATL_NO_VTABLE BandwidthGroup :
28 public BandwidthGroupWrap
29{
30public:
31
32 DECLARE_EMPTY_CTOR_DTOR(BandwidthGroup)
33
34 HRESULT FinalConstruct();
35 void FinalRelease();
36
37 // public initializer/uninitializer for internal purposes only
38 HRESULT init(BandwidthControl *aParent,
39 const com::Utf8Str &aName,
40 BandwidthGroupType_T aType,
41 LONG64 aMaxBytesPerSec);
42 HRESULT init(BandwidthControl *aParent, BandwidthGroup *aThat, bool aReshare = false);
43 HRESULT initCopy(BandwidthControl *aParent, BandwidthGroup *aThat);
44 void uninit();
45
46 // public methods only for internal purposes
47 void i_rollback();
48 void i_commit();
49 void i_unshare();
50 void i_reference();
51 void i_release();
52
53 ComObjPtr<BandwidthGroup> i_getPeer() { return m->pPeer; }
54 const Utf8Str &i_getName() const { return m->bd->mData.strName; }
55 BandwidthGroupType_T i_getType() const { return m->bd->mData.enmType; }
56 LONG64 i_getMaxBytesPerSec() const { return m->bd->mData.cMaxBytesPerSec; }
57 ULONG i_getReferences() const { return m->bd->cReferences; }
58
59private:
60
61 // wrapped IBandwidthGroup properties
62 HRESULT getName(com::Utf8Str &aName);
63 HRESULT getType(BandwidthGroupType_T *aType);
64 HRESULT getReference(ULONG *aReferences);
65 HRESULT getMaxBytesPerSec(LONG64 *aMaxBytesPerSec);
66 HRESULT setMaxBytesPerSec(LONG64 MaxBytesPerSec);
67
68 ////////////////////////////////////////////////////////////////////////////////
69 ////
70 //// private member data definition
71 ////
72 //////////////////////////////////////////////////////////////////////////////////
73 //
74 struct BackupableBandwidthGroupData
75 {
76 BackupableBandwidthGroupData()
77 : cReferences(0)
78 { }
79
80 settings::BandwidthGroup mData;
81 ULONG cReferences;
82 };
83
84 struct Data
85 {
86 Data(BandwidthControl * const aBandwidthControl)
87 : pParent(aBandwidthControl),
88 pPeer(NULL)
89 { }
90
91 BandwidthControl * const pParent;
92 ComObjPtr<BandwidthGroup> pPeer;
93
94 // use the XML settings structure in the members for simplicity
95 Backupable<BackupableBandwidthGroupData> bd;
96 };
97
98 Data *m;
99};
100
101#endif // ____H_BANDWIDTHGROUPIMPL
102/* vi: set tabstop=4 shiftwidth=4 expandtab: */
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