StorageControllerImpl.h revision 4182d14dc02dba6587c15e358b87e5c9a6e60d15
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync/* $Id$ */
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync/** @file
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync *
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * VBox StorageController COM Class declaration.
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync */
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync/*
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * Copyright (C) 2008 Sun Microsystems, Inc.
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync *
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * available from http://www.virtualbox.org. This file is free software;
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * you can redistribute it and/or modify it under the terms of the GNU
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * General Public License (GPL) as published by the Free Software
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync *
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync * additional information or have any questions.
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync */
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync#ifndef ____H_STORAGECONTROLLERIMPL
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync#define ____H_STORAGECONTROLLERIMPL
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync#include "VirtualBoxBase.h"
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsyncclass Machine;
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsyncclass ATL_NO_VTABLE StorageController :
168d8e5243c71b5d181b789b3b6370ae562c5d0bvboxsync public VirtualBoxBase,
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync public VirtualBoxSupportErrorInfoImpl<StorageController, IStorageController>,
f32de6c198a491c28ace2b4c53f8d04a79fd6d69vboxsync public VirtualBoxSupportTranslation<StorageController>,
0ce6ae9d6efed5d54222a13bbdabce9e688e4447vboxsync VBOX_SCRIPTABLE_IMPL(IStorageController)
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync{
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsyncpublic:
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (StorageController)
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync DECLARE_NOT_AGGREGATABLE (StorageController)
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync BEGIN_COM_MAP(StorageController)
57b49c1557a310ee615bc0ee79dd2a2e92319a1bvboxsync COM_INTERFACE_ENTRY (ISupportErrorInfo)
57b49c1557a310ee615bc0ee79dd2a2e92319a1bvboxsync COM_INTERFACE_ENTRY (IStorageController)
57b49c1557a310ee615bc0ee79dd2a2e92319a1bvboxsync COM_INTERFACE_ENTRY2 (IDispatch, IStorageController)
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync END_COM_MAP()
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync StorageController() { };
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync ~StorageController() { };
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync HRESULT FinalConstruct();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync void FinalRelease();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // public initializer/uninitializer for internal purposes only
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync HRESULT init(Machine *aParent,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync const Utf8Str &aName,
c8faf7a704e698dec3679d7df43ae55b1bab3eadvboxsync StorageBus_T aBus,
c8faf7a704e698dec3679d7df43ae55b1bab3eadvboxsync ULONG aInstance);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync HRESULT init(Machine *aParent,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync StorageController *aThat,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync bool aReshare = false);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync HRESULT initCopy(Machine *aParent,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync StorageController *aThat);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync void uninit();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // IStorageController properties
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(Name)) (BSTR *aName);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(Bus)) (StorageBus_T *aBus);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(ControllerType)) (StorageControllerType_T *aControllerType);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMSETTER(ControllerType)) (StorageControllerType_T aControllerType);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(MaxDevicesPerPortCount)) (ULONG *aMaxDevices);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(MinPortCount)) (ULONG *aMinPortCount);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(MaxPortCount)) (ULONG *aMaxPortCount);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(PortCount)) (ULONG *aPortCount);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMSETTER(PortCount)) (ULONG aPortCount);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMGETTER(Instance)) (ULONG *aInstance);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(COMSETTER(Instance)) (ULONG aInstance);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // StorageController methods
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(GetIDEEmulationPort) (LONG DevicePosition, LONG *aPortNumber);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync STDMETHOD(SetIDEEmulationPort) (LONG DevicePosition, LONG aPortNumber);
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // public methods only for internal purposes
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync const Utf8Str &getName() const;
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync StorageControllerType_T getControllerType() const;
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync StorageBus_T getStorageBus() const;
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync ULONG getInstance() const;
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync bool isModified();
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync bool isReallyModified();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync bool rollback();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync void commit();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // public methods for internal purposes only
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // (ensure there is a caller and a read lock before calling them!)
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync void unshare();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync /** @note this doesn't require a read lock since mParent is constant. */
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync const ComObjPtr<Machine, ComWeakRef>& getMachine();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync ComObjPtr<StorageController> getPeer();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync // for VirtualBoxSupportErrorInfoImpl
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync static const wchar_t *getComponentName() { return L"StorageController"; }
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsyncprivate:
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync void printList();
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync struct Data;
4182d14dc02dba6587c15e358b87e5c9a6e60d15vboxsync Data *m;
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync};
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync#endif //!____H_STORAGECONTROLLERIMPL
7189dad3705d42e9874af1e1c8a8c7e5cceee9f7vboxsync/* vi: set tabstop=4 shiftwidth=4 expandtab: */