| 1 | /* $Id: AutostartDb.h 93115 2022-01-01 11:31:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * Main - Autostart database Interfaces.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2012-2022 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 MAIN_INCLUDED_AutostartDb_h
|
|---|
| 19 | #define MAIN_INCLUDED_AutostartDb_h
|
|---|
| 20 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 21 | # pragma once
|
|---|
| 22 | #endif
|
|---|
| 23 |
|
|---|
| 24 | #include <iprt/cdefs.h>
|
|---|
| 25 | #include <iprt/types.h>
|
|---|
| 26 | #include <iprt/critsect.h>
|
|---|
| 27 |
|
|---|
| 28 | class AutostartDb
|
|---|
| 29 | {
|
|---|
| 30 | public:
|
|---|
| 31 |
|
|---|
| 32 | AutostartDb();
|
|---|
| 33 | ~AutostartDb();
|
|---|
| 34 |
|
|---|
| 35 | /**
|
|---|
| 36 | * Sets the path to the autostart database.
|
|---|
| 37 | *
|
|---|
| 38 | * @returns VBox status code.
|
|---|
| 39 | * @param pszAutostartDbPathNew Path to the autostart database.
|
|---|
| 40 | */
|
|---|
| 41 | int setAutostartDbPath(const char *pszAutostartDbPathNew);
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * Add a autostart VM to the global database.
|
|---|
| 45 | *
|
|---|
| 46 | * @returns VBox status code.
|
|---|
| 47 | * @retval VERR_PATH_NOT_FOUND if the autostart database directory is not set.
|
|---|
| 48 | * @param pszVMId ID of the VM to add.
|
|---|
| 49 | */
|
|---|
| 50 | int addAutostartVM(const char *pszVMId);
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * Remove a autostart VM from the global database.
|
|---|
| 54 | *
|
|---|
| 55 | * @returns VBox status code.
|
|---|
| 56 | * @retval VERR_PATH_NOT_FOUND if the autostart database directory is not set.
|
|---|
| 57 | * @param pszVMId ID of the VM to remove.
|
|---|
| 58 | */
|
|---|
| 59 | int removeAutostartVM(const char *pszVMId);
|
|---|
| 60 |
|
|---|
| 61 | /**
|
|---|
| 62 | * Add a autostop VM to the global database.
|
|---|
| 63 | *
|
|---|
| 64 | * @returns VBox status code.
|
|---|
| 65 | * @retval VERR_PATH_NOT_FOUND if the autostart database directory is not set.
|
|---|
| 66 | * @param pszVMId ID of the VM to add.
|
|---|
| 67 | */
|
|---|
| 68 | int addAutostopVM(const char *pszVMId);
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * Remove a autostop VM from the global database.
|
|---|
| 72 | *
|
|---|
| 73 | * @returns VBox status code.
|
|---|
| 74 | * @retval VERR_PATH_NOT_FOUND if the autostart database directory is not set.
|
|---|
| 75 | * @param pszVMId ID of the VM to remove.
|
|---|
| 76 | */
|
|---|
| 77 | int removeAutostopVM(const char *pszVMId);
|
|---|
| 78 |
|
|---|
| 79 | private:
|
|---|
| 80 |
|
|---|
| 81 | #ifdef RT_OS_LINUX
|
|---|
| 82 | /** Critical section protecting the database against concurrent access. */
|
|---|
| 83 | RTCRITSECT CritSect;
|
|---|
| 84 | /** Path to the autostart database. */
|
|---|
| 85 | char *m_pszAutostartDbPath;
|
|---|
| 86 |
|
|---|
| 87 | /**
|
|---|
| 88 | * Autostart database modification worker.
|
|---|
| 89 | *
|
|---|
| 90 | * @returns VBox status code.
|
|---|
| 91 | * @param fAutostart Flag whether the autostart or autostop database is modified.
|
|---|
| 92 | * @param fAddVM Flag whether a VM is added or removed from the database.
|
|---|
| 93 | */
|
|---|
| 94 | int autostartModifyDb(bool fAutostart, bool fAddVM);
|
|---|
| 95 | #endif
|
|---|
| 96 | };
|
|---|
| 97 |
|
|---|
| 98 | #endif /* !MAIN_INCLUDED_AutostartDb_h */
|
|---|
| 99 |
|
|---|
