summaryrefslogtreecommitdiffstats
path: root/include/freerdp/server/location.h
blob: 8078878f999bcbc2e6cdd5481a6e542cb5882746 (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Location Virtual Channel Extension
 *
 * Copyright 2023 Pascal Nowack <Pascal.Nowack@gmx.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *	 http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FREERDP_CHANNEL_LOCATION_SERVER_LOCATION_H
#define FREERDP_CHANNEL_LOCATION_SERVER_LOCATION_H

#include <freerdp/channels/location.h>
#include <freerdp/channels/wtsvc.h>

#ifdef __cplusplus
extern "C"
{
#endif

	typedef struct s_location_server_context LocationServerContext;

	typedef UINT (*psLocationServerOpen)(LocationServerContext* context);
	typedef UINT (*psLocationServerClose)(LocationServerContext* context);

	typedef BOOL (*psLocationServerChannelIdAssigned)(LocationServerContext* context,
	                                                  UINT32 channelId);

	typedef UINT (*psLocationServerInitialize)(LocationServerContext* context, BOOL externalThread);
	typedef UINT (*psLocationServerPoll)(LocationServerContext* context);
	typedef BOOL (*psLocationServerChannelHandle)(LocationServerContext* context, HANDLE* handle);

	typedef UINT (*psLocationServerServerReady)(LocationServerContext* context,
	                                            const RDPLOCATION_SERVER_READY_PDU* serverReady);
	typedef UINT (*psLocationServerClientReady)(LocationServerContext* context,
	                                            const RDPLOCATION_CLIENT_READY_PDU* clientReady);

	typedef UINT (*psLocationServerBaseLocation3D)(
	    LocationServerContext* context, const RDPLOCATION_BASE_LOCATION3D_PDU* baseLocation3D);
	typedef UINT (*psLocationServerLocation2DDelta)(
	    LocationServerContext* context, const RDPLOCATION_LOCATION2D_DELTA_PDU* location2DDelta);
	typedef UINT (*psLocationServerLocation3DDelta)(
	    LocationServerContext* context, const RDPLOCATION_LOCATION3D_DELTA_PDU* location3DDelta);

	struct s_location_server_context
	{
		HANDLE vcm;

		/* Server self-defined pointer. */
		void* userdata;

		/*** APIs called by the server. ***/

		/**
		 * Optional: Set thread handling.
		 * When externalThread=TRUE, the application is responsible to call
		 * Poll() periodically to process channel events.
		 *
		 * Defaults to externalThread=FALSE
		 */
		psLocationServerInitialize Initialize;

		/**
		 * Open the location channel.
		 */
		psLocationServerOpen Open;

		/**
		 * Close the location channel.
		 */
		psLocationServerClose Close;

		/**
		 * Poll
		 * When externalThread=TRUE, call Poll() periodically from your main loop.
		 * If externalThread=FALSE do not call.
		 */
		psLocationServerPoll Poll;

		/**
		 * Retrieve the channel handle for use in conjunction with Poll().
		 * If externalThread=FALSE do not call.
		 */
		psLocationServerChannelHandle ChannelHandle;

		/* All PDUs sent by the server don't require the header to be set */

		/*
		 * Send a ServerReady PDU.
		 */
		psLocationServerServerReady ServerReady;

		/*** Callbacks registered by the server. ***/

		/**
		 * Callback, when the channel got its id assigned.
		 */
		psLocationServerChannelIdAssigned ChannelIdAssigned;

		/**
		 * Callback for the ClientReady PDU.
		 */
		psLocationServerClientReady ClientReady;

		/**
		 * Callback for the BaseLocation3D PDU.
		 */
		psLocationServerBaseLocation3D BaseLocation3D;

		/**
		 * Callback for the Location2DDelta PDU.
		 */
		psLocationServerLocation2DDelta Location2DDelta;

		/**
		 * Callback for the Location3DDelta PDU.
		 */
		psLocationServerLocation3DDelta Location3DDelta;

		rdpContext* rdpcontext;
	};

	FREERDP_API void location_server_context_free(LocationServerContext* context);

	WINPR_ATTR_MALLOC(location_server_context_free, 1)
	FREERDP_API LocationServerContext* location_server_context_new(HANDLE vcm);

#ifdef __cplusplus
}
#endif

#endif /* FREERDP_CHANNEL_LOCATION_SERVER_LOCATION_H */