summaryrefslogtreecommitdiffstats
path: root/include/freerdp/server/rdpemsc.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 01:24:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 01:24:41 +0000
commita9bcc81f821d7c66f623779fa5147e728eb3c388 (patch)
tree98676963bcdd537ae5908a067a8eb110b93486a6 /include/freerdp/server/rdpemsc.h
parentInitial commit. (diff)
downloadfreerdp3-a9bcc81f821d7c66f623779fa5147e728eb3c388.tar.xz
freerdp3-a9bcc81f821d7c66f623779fa5147e728eb3c388.zip
Adding upstream version 3.3.0+dfsg1.upstream/3.3.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'include/freerdp/server/rdpemsc.h')
-rw-r--r--include/freerdp/server/rdpemsc.h132
1 files changed, 132 insertions, 0 deletions
diff --git a/include/freerdp/server/rdpemsc.h b/include/freerdp/server/rdpemsc.h
new file mode 100644
index 0000000..f1ce98a
--- /dev/null
+++ b/include/freerdp/server/rdpemsc.h
@@ -0,0 +1,132 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol Implementation
+ * Mouse Cursor 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_RDPEMSC_SERVER_RDPEMSC_H
+#define FREERDP_CHANNEL_RDPEMSC_SERVER_RDPEMSC_H
+
+#include <freerdp/channels/rdpemsc.h>
+#include <freerdp/channels/wtsvc.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ typedef struct s_mouse_cursor_server_context MouseCursorServerContext;
+
+ typedef UINT (*psMouseCursorServerOpen)(MouseCursorServerContext* context);
+ typedef UINT (*psMouseCursorServerClose)(MouseCursorServerContext* context);
+
+ typedef BOOL (*psMouseCursorServerChannelIdAssigned)(MouseCursorServerContext* context,
+ UINT32 channelId);
+
+ typedef UINT (*psMouseCursorServerInitialize)(MouseCursorServerContext* context,
+ BOOL externalThread);
+ typedef UINT (*psMouseCursorServerPoll)(MouseCursorServerContext* context);
+ typedef BOOL (*psMouseCursorServerChannelHandle)(MouseCursorServerContext* context,
+ HANDLE* handle);
+
+ typedef UINT (*psMouseCursorServerCapsAdvertise)(
+ MouseCursorServerContext* context,
+ const RDP_MOUSE_CURSOR_CAPS_ADVERTISE_PDU* capsAdvertise);
+ typedef UINT (*psMouseCursorServerCapsConfirm)(
+ MouseCursorServerContext* context, const RDP_MOUSE_CURSOR_CAPS_CONFIRM_PDU* capsConfirm);
+
+ typedef UINT (*psMouseCursorServerMouseptrUpdate)(
+ MouseCursorServerContext* context,
+ const RDP_MOUSE_CURSOR_MOUSEPTR_UPDATE_PDU* mouseptrUpdate);
+
+ struct s_mouse_cursor_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
+ */
+ psMouseCursorServerInitialize Initialize;
+
+ /**
+ * Open the mouse cursor channel.
+ */
+ psMouseCursorServerOpen Open;
+
+ /**
+ * Close the mouse cursor channel.
+ */
+ psMouseCursorServerClose Close;
+
+ /**
+ * Poll
+ * When externalThread=TRUE, call Poll() periodically from your main loop.
+ * If externalThread=FALSE do not call.
+ */
+ psMouseCursorServerPoll Poll;
+
+ /**
+ * Retrieve the channel handle for use in conjunction with Poll().
+ * If externalThread=FALSE do not call.
+ */
+ psMouseCursorServerChannelHandle ChannelHandle;
+
+ /* All PDUs sent by the server don't require the pduType to be set */
+
+ /*
+ * Send a CapsConfirm PDU.
+ */
+ psMouseCursorServerCapsConfirm CapsConfirm;
+
+ /*
+ * Send a MouseptrUpdate PDU.
+ */
+ psMouseCursorServerMouseptrUpdate MouseptrUpdate;
+
+ /*** Callbacks registered by the server. ***/
+
+ /**
+ * Callback, when the channel got its id assigned.
+ */
+ psMouseCursorServerChannelIdAssigned ChannelIdAssigned;
+
+ /**
+ * Callback for the CapsAdvertise PDU.
+ */
+ psMouseCursorServerCapsAdvertise CapsAdvertise;
+
+ rdpContext* rdpcontext;
+ };
+
+ FREERDP_API void mouse_cursor_server_context_free(MouseCursorServerContext* context);
+
+ WINPR_ATTR_MALLOC(mouse_cursor_server_context_free, 1)
+ FREERDP_API MouseCursorServerContext* mouse_cursor_server_context_new(HANDLE vcm);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* FREERDP_CHANNEL_RDPEMSC_SERVER_RDPEMSC_H */