wtsvc: add public API.

include/freerdp/channels/wtsvc.h

@@ -0,0 +1,102 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol client.
+ * Server Virtual Channel Interface
+ *
+ * Copyright 2011-2012 Vic Lee
+ *
+ * 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.
+ */
+
+/**
+ * The server-side virtual channel API follows the Microsoft Remote Desktop
+ * Services API functions WTSVirtualChannel* defined in:
+ * http://msdn.microsoft.com/en-us/library/windows/desktop/aa383464.aspx
+ *
+ * Difference between the MS API are documented in this header. All functions
+ * are implemented in and integrated with libfreerdp-channels.
+ *
+ * Thread-safety: the API is designed to be safe to use one thread per channel.
+ * To access a virtual channel from multiple threads, one must provide his own
+ * machanism to protect the virtual channel handle.
+ */
+
+#ifndef __FREERDP_WTSVC_H
+#define __FREERDP_WTSVC_H
+
+#include <freerdp/types.h>
+#include <freerdp/peer.h>
+
+#define WTS_CHANNEL_OPTION_DYNAMIC 0x00000001
+
+typedef enum _WTS_VIRTUAL_CLASS
+{
+	WTSVirtualClientData,
+	WTSVirtualFileHandle 
+} WTS_VIRTUAL_CLASS;
+
+/**
+ * Opens a static or dynamic virtual channel and return the handle. If the
+ * operation fails, a NULL handle is returned.
+ * 
+ * The original MS API has 'DWORD SessionId' as the first argument, while we
+ * just use the server peer instance (representing the session) instead.
+ */
+FREERDP_API void* WTSVirtualChannelOpenEx(
+	/* __in */ freerdp_peer* client,
+	/* __in */ const char* pVirtualName,
+	/* __in */ uint32 flags);
+
+/**
+ * Returns information about a specified virtual channel.
+ *
+ * Servers use this function to gain access to a virtual channel file handle
+ * that can be used for asynchronous I/O.
+ */
+FREERDP_API boolean WTSVirtualChannelQuery(
+	/* __in */  void* hChannelHandle,
+	/* __in */  WTS_VIRTUAL_CLASS WtsVirtualClass,
+	/* __out */ void** ppBuffer,
+	/* __out */ uint32* pBytesReturned);
+
+/**
+ * Frees memory allocated by WTSVirtualChannelQuery
+ */
+FREERDP_API void WTSFreeMemory(
+	/* __in */ void* pMemory);
+
+/**
+ * Reads data from the server end of a virtual channel.
+ */
+FREERDP_API boolean WTSVirtualChannelRead(
+	/* __in */  void* hChannelHandle,
+	/* __in */  uint32 TimeOut,
+	/* __out */ uint8* Buffer,
+	/* __in */  uint32 BufferSize,
+	/* __out */ uint32* pBytesRead);
+
+/**
+ * Writes data to the server end of a virtual channel.
+ */
+FREERDP_API boolean WTSVirtualChannelWrite(
+	/* __in */  void* hChannelHandle,
+	/* __in */  uint8* Buffer,
+	/* __in */  uint32 Length,
+	/* __out */ uint32* pBytesWritten);
+
+/**
+ * Closes an open virtual channel handle.
+ */
+FREERDP_API boolean WTSVirtualChannelClose(
+	/* __in */ void* hChannelHandle);
+
+#endif /* __FREERDP_WTSVC_H */

libfreerdp-channels/CMakeLists.txt

@@ -19,7 +19,8 @@
 
 set(FREERDP_CHANNELS_SRCS
 	libchannels.c
-	libchannels.h)
+	libchannels.h
+	wtsvc.c)
 
 add_library(freerdp-channels ${FREERDP_CHANNELS_SRCS})
 

libfreerdp-channels/wtsvc.c

@@ -0,0 +1,73 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol client.
+ * Server Virtual Channel Interface
+ *
+ * Copyright 2011-2012 Vic Lee
+ *
+ * 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.
+ */
+
+#include "config.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <freerdp/freerdp.h>
+#include <freerdp/utils/memory.h>
+#include <freerdp/channels/wtsvc.h>
+
+void* WTSVirtualChannelOpenEx(
+	/* __in */ freerdp_peer* client,
+	/* __in */ const char* pVirtualName,
+	/* __in */ uint32 flags)
+{
+	return NULL;
+}
+
+boolean WTSVirtualChannelQuery(
+	/* __in */  void* hChannelHandle,
+	/* __in */  WTS_VIRTUAL_CLASS WtsVirtualClass,
+	/* __out */ void** ppBuffer,
+	/* __out */ uint32* pBytesReturned)
+{
+	return false;
+}
+
+void WTSFreeMemory(
+	/* __in */ void* pMemory)
+{
+}
+
+boolean WTSVirtualChannelRead(
+	/* __in */  void* hChannelHandle,
+	/* __in */  uint32 TimeOut,
+	/* __out */ uint8* Buffer,
+	/* __in */  uint32 BufferSize,
+	/* __out */ uint32* pBytesRead)
+{
+	return false;
+}
+
+boolean WTSVirtualChannelWrite(
+	/* __in */  void* hChannelHandle,
+	/* __in */  uint8* Buffer,
+	/* __in */  uint32 Length,
+	/* __out */ uint32* pBytesWritten)
+{
+	return false;
+}
+
+boolean WTSVirtualChannelClose(
+	/* __in */ void* hChannelHandle)
+{
+	return false;
+}