/* $Id: NetworkAdapterImpl.h 14664 2008-11-26 21:19:35Z vboxsync $ */ /** @file * * VirtualBox COM class implementation */ /* * Copyright (C) 2006-2007 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ #ifndef ____H_NETWORKADAPTER #define ____H_NETWORKADAPTER #include "VirtualBoxBase.h" #include "Collection.h" class Machine; class GuestOSType; class ATL_NO_VTABLE NetworkAdapter : public VirtualBoxBaseNEXT, public VirtualBoxSupportErrorInfoImpl , public VirtualBoxSupportTranslation , public INetworkAdapter { public: struct Data { Data() : mSlot (0), mEnabled (FALSE) , mAttachmentType (NetworkAttachmentType_Null) , mCableConnected (TRUE), mLineSpeed (0), mTraceEnabled (FALSE) #ifndef VBOX_WITH_UNIXY_TAP_NETWORKING , mHostInterface ("") // cannot be null #else , mTAPFD (NIL_RTFILE) #endif {} bool operator== (const Data &that) const { return this == &that || (mSlot == that.mSlot && mEnabled == that.mEnabled && mMACAddress == that.mMACAddress && mAttachmentType == that.mAttachmentType && mCableConnected == that.mCableConnected && mLineSpeed == that.mLineSpeed && mTraceEnabled == that.mTraceEnabled && mHostInterface == that.mHostInterface && #ifdef VBOX_WITH_UNIXY_TAP_NETWORKING mTAPSetupApplication == that.mTAPSetupApplication && mTAPTerminateApplication == that.mTAPTerminateApplication && mTAPFD == that.mTAPFD && #endif mInternalNetwork == that.mInternalNetwork && mNATNetwork == that.mNATNetwork); } NetworkAdapterType_T mAdapterType; ULONG mSlot; BOOL mEnabled; Bstr mMACAddress; NetworkAttachmentType_T mAttachmentType; BOOL mCableConnected; ULONG mLineSpeed; BOOL mTraceEnabled; Bstr mTraceFile; Bstr mHostInterface; #ifdef VBOX_WITH_UNIXY_TAP_NETWORKING Bstr mTAPSetupApplication; Bstr mTAPTerminateApplication; RTFILE mTAPFD; #endif Bstr mInternalNetwork; Bstr mNATNetwork; }; VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (NetworkAdapter) DECLARE_NOT_AGGREGATABLE(NetworkAdapter) DECLARE_PROTECT_FINAL_CONSTRUCT() BEGIN_COM_MAP(NetworkAdapter) COM_INTERFACE_ENTRY(ISupportErrorInfo) COM_INTERFACE_ENTRY(INetworkAdapter) END_COM_MAP() NS_DECL_ISUPPORTS DECLARE_EMPTY_CTOR_DTOR (NetworkAdapter) HRESULT FinalConstruct(); void FinalRelease(); // public initializer/uninitializer for internal purposes only HRESULT init (Machine *aParent, ULONG aSlot); HRESULT init (Machine *aParent, NetworkAdapter *aThat); HRESULT initCopy (Machine *aParent, NetworkAdapter *aThat); void uninit(); // INetworkAdapter properties STDMETHOD(COMGETTER(AdapterType))(NetworkAdapterType_T *aAdapterType); STDMETHOD(COMSETTER(AdapterType))(NetworkAdapterType_T aAdapterType); STDMETHOD(COMGETTER(Slot)) (ULONG *aSlot); STDMETHOD(COMGETTER(Enabled)) (BOOL *aEnabled); STDMETHOD(COMSETTER(Enabled)) (BOOL aEnabled); STDMETHOD(COMGETTER(MACAddress)) (BSTR *aMACAddress); STDMETHOD(COMSETTER(MACAddress)) (INPTR BSTR aMACAddress); STDMETHOD(COMGETTER(AttachmentType)) (NetworkAttachmentType_T *aAttachmentType); STDMETHOD(COMGETTER(HostInterface)) (BSTR *aHostInterface); STDMETHOD(COMSETTER(HostInterface)) (INPTR BSTR aHostInterface); #ifndef RT_OS_WINDOWS /** @todo ifdef VBOX_WITH_UNIXY_TAP_NETWORKING: need to find a way to exclude this in the xidl... */ STDMETHOD(COMGETTER(TAPFileDescriptor)) (LONG *aTAPFileDescriptor); STDMETHOD(COMSETTER(TAPFileDescriptor)) (LONG aTAPFileDescriptor); STDMETHOD(COMGETTER(TAPSetupApplication)) (BSTR *aTAPSetupApplication); STDMETHOD(COMSETTER(TAPSetupApplication)) (INPTR BSTR aTAPSetupApplication); STDMETHOD(COMGETTER(TAPTerminateApplication)) (BSTR *aTAPTerminateApplication); STDMETHOD(COMSETTER(TAPTerminateApplication)) (INPTR BSTR aTAPTerminateApplication); #endif STDMETHOD(COMGETTER(InternalNetwork)) (BSTR *aInternalNetwork); STDMETHOD(COMSETTER(InternalNetwork)) (INPTR BSTR aInternalNetwork); STDMETHOD(COMGETTER(NATNetwork)) (BSTR *aNATNetwork); STDMETHOD(COMSETTER(NATNetwork)) (INPTR BSTR aNATNetwork); STDMETHOD(COMGETTER(CableConnected)) (BOOL *aConnected); STDMETHOD(COMSETTER(CableConnected)) (BOOL aConnected); STDMETHOD(COMGETTER(TraceEnabled)) (BOOL *aEnabled); STDMETHOD(COMSETTER(TraceEnabled)) (BOOL aEnabled); STDMETHOD(COMGETTER(LineSpeed)) (ULONG *aSpeed); STDMETHOD(COMSETTER(LineSpeed)) (ULONG aSpeed); STDMETHOD(COMGETTER(TraceFile)) (BSTR *aTraceFile); STDMETHOD(COMSETTER(TraceFile)) (INPTR BSTR aTraceFile); // INetworkAdapter methods STDMETHOD(AttachToNAT)(); STDMETHOD(AttachToHostInterface)(); STDMETHOD(AttachToInternalNetwork)(); STDMETHOD(Detach)(); // public methods only for internal purposes HRESULT loadSettings (const settings::Key &aAdapterNode); HRESULT saveSettings (settings::Key &aAdapterNode); bool isModified() { AutoWriteLock alock (this); return mData.isBackedUp(); } bool isReallyModified() { AutoWriteLock alock (this); return mData.hasActualChanges(); } bool rollback(); void commit(); void copyFrom (NetworkAdapter *aThat); void applyDefaults (GuestOSType *aOsType); // public methods for internal purposes only // (ensure there is a caller and a read lock before calling them!) const Backupable &data() const { return mData; } // for VirtualBoxSupportErrorInfoImpl static const wchar_t *getComponentName() { return L"NetworkAdapter"; } private: void detach(); void generateMACAddress(); const ComObjPtr mParent; const ComObjPtr mPeer; Backupable mData; }; #endif // ____H_NETWORKADAPTER