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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* @file
* VBox Remote Desktop Extension (VRDE) - raw TSMF dynamic channel interface.
*/
/*
* Copyright (C) 2012-2023 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>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_RemoteDesktop_VRDETSMF_h
#define VBOX_INCLUDED_RemoteDesktop_VRDETSMF_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/RemoteDesktop/VRDE.h>
/*
* Interface creating a TSMF dynamic channel instances and sending/receving data.
*
* Async callbacks are used for providing feedback, reporting errors, etc.
*/
#define VRDE_TSMF_INTERFACE_NAME "TSMFRAW"
/* The VRDE server TSMF interface entry points. Interface version 1. */
typedef struct VRDETSMFINTERFACE
{
/* The header. */
VRDEINTERFACEHDR header;
/* Create a new TSMF channel instance.
* The channel is created only for one client, which is connected to the server.
* The client is the first which supports dynamic RDP channels.
*
* If this method return success then the server will use the VRDE_TSMF_N_CREATE_*
* notification to report the channel handle.
*
* @param hServer The VRDE server instance.
* @param pvChannel A context to be associated with the channel.
* @param u32Flags VRDE_TSMF_F_*
*
* @return IPRT status code.
*/
DECLR3CALLBACKMEMBER(int, VRDETSMFChannelCreate, (HVRDESERVER hServer,
void *pvChannel,
uint32_t u32Flags));
/* Close a TSMF channel instance.
*
* @param hServer The VRDE server instance.
* @param u32ChannelHandle Which channel to close.
*
* @return IPRT status code.
*/
DECLR3CALLBACKMEMBER(int, VRDETSMFChannelClose, (HVRDESERVER hServer,
uint32_t u32ChannelHandle));
/* Send data to the TSMF channel instance.
*
* @param hServer The VRDE server instance.
* @param u32ChannelHandle Channel to send data.
* @param pvData Raw data to be sent, the format depends on which
* u32Flags were specified in Create: TSMF message,
* or channel header + TSMF message.
* @param cbData Size of data.
*
* @return IPRT status code.
*/
DECLR3CALLBACKMEMBER(int, VRDETSMFChannelSend, (HVRDESERVER hServer,
uint32_t u32ChannelHandle,
const void *pvData,
uint32_t cbData));
} VRDETSMFINTERFACE;
/* TSMF interface callbacks. */
typedef struct VRDETSMFCALLBACKS
{
/* The header. */
VRDEINTERFACEHDR header;
/* Channel event notification.
*
* @param pvContext The callbacks context specified in VRDEGetInterface.
* @param u32Notification The kind of the notification: VRDE_TSMF_N_*.
* @param pvChannel A context which was used in VRDETSMFChannelCreate.
* @param pvParm The notification specific data.
* @param cbParm The size of buffer pointed by pvParm.
*
* @return IPRT status code.
*/
DECLR3CALLBACKMEMBER(void, VRDETSMFCbNotify, (void *pvContext,
uint32_t u32Notification,
void *pvChannel,
const void *pvParm,
uint32_t cbParm));
} VRDETSMFCALLBACKS;
/* VRDETSMFChannelCreate::u32Flags */
#define VRDE_TSMF_F_CHANNEL_HEADER 0x00000001
/* VRDETSMFCbNotify::u32Notification */
#define VRDE_TSMF_N_CREATE_ACCEPTED 1
#define VRDE_TSMF_N_CREATE_DECLINED 2
#define VRDE_TSMF_N_DATA 3 /* Data received. */
#define VRDE_TSMF_N_DISCONNECTED 4 /* The channel is not connected anymore. */
/*
* Notification parameters.
*/
/* VRDE_TSMF_N_CREATE_ACCEPTED */
typedef struct VRDETSMFNOTIFYCREATEACCEPTED
{
uint32_t u32ChannelHandle;
} VRDETSMFNOTIFYCREATEACCEPTED;
/* VRDE_TSMF_N_EVENT_DATA */
typedef struct VRDETSMFNOTIFYDATA
{
const void *pvData;
uint32_t cbData; /* How many bytes available. */
} VRDETSMFNOTIFYDATA;
#endif /* !VBOX_INCLUDED_RemoteDesktop_VRDETSMF_h */
|
