blob: 856819526b2f04029fd3acd2d60114b056475419 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* $Id: ClientToken.h $ */
/** @file
*
* VirtualBox API client session token abstraction
*/
/*
* Copyright (C) 2013-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_ClientToken_h
#define MAIN_INCLUDED_ClientToken_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/com/ptr.h>
#include <VBox/com/AutoLock.h>
#include "MachineImpl.h"
#ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
# include "TokenImpl.h"
#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
#if defined(RT_OS_WINDOWS)
# define CTTOKENARG NULL
# define CTTOKENTYPE HANDLE
#elif defined(RT_OS_OS2)
# define CTTOKENARG NULLHANDLE
# define CTTOKENTYPE HMTX
#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
# define CTTOKENARG -1
# define CTTOKENTYPE int
#elif defined(VBOX_WITH_GENERIC_SESSION_WATCHER)
# define CTTOKENARG NULL
# define CTTOKENTYPE MachineToken *
#else
# error "Port me!"
#endif
/**
* Class which represents a token which can be used to check for client
* crashes and similar purposes.
*/
class Machine::ClientToken
{
public:
/**
* Constructor which creates a usable instance
*
* @param pMachine Reference to Machine object
* @param pSessionMachine Reference to corresponding SessionMachine object
*/
ClientToken(const ComObjPtr<Machine> &pMachine, SessionMachine *pSessionMachine);
/**
* Default destructor. Cleans everything up.
*/
~ClientToken();
/**
* Check if object contains a usable token.
*/
bool isReady();
/**
* Query token ID, which is a unique string value for this token. Do not
* assume any specific content/format, it is opaque information.
*/
void getId(Utf8Str &strId);
/**
* Query token, which is platform dependent.
*/
CTTOKENTYPE getToken();
#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
/**
* Release token now. Returns information if the client has terminated.
*/
bool release();
#endif /* !VBOX_WITH_GENERIC_SESSION_WATCHER */
private:
/**
* Default constructor. Don't use, will not create a sensible instance.
*/
ClientToken();
Machine *mMachine;
CTTOKENTYPE mClientToken;
Utf8Str mClientTokenId;
#ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
bool mClientTokenPassed;
#endif
};
#endif /* !MAIN_INCLUDED_ClientToken_h */
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
