2 * FreeRDP: A Remote Desktop Protocol Implementation
5 * Copyright 2013 Marc-Andre Moreau <marcandre.moreau@gmail.com>
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
20 #ifndef FREERDP_CLIENT_H
21 #define FREERDP_CLIENT_H
23 #include <freerdp/api.h>
24 #include <freerdp/freerdp.h>
35 typedef BOOL (*pRdpGlobalInit)(void);
36 typedef void (*pRdpGlobalUninit)(void);
38 typedef BOOL (*pRdpClientNew)(freerdp* instance, rdpContext* context);
39 typedef void (*pRdpClientFree)(freerdp* instance, rdpContext* context);
41 typedef int (*pRdpClientStart)(rdpContext* context);
42 typedef int (*pRdpClientStop)(rdpContext* context);
44 struct rdp_client_entry_points_v1
49 rdpSettings* settings;
51 pRdpGlobalInit GlobalInit;
52 pRdpGlobalUninit GlobalUninit;
55 pRdpClientNew ClientNew;
56 pRdpClientFree ClientFree;
58 pRdpClientStart ClientStart;
59 pRdpClientStop ClientStop;
62 #define RDP_CLIENT_INTERFACE_VERSION 1
63 #define RDP_CLIENT_ENTRY_POINT_NAME "RdpClientEntry"
65 typedef int (*pRdpClientEntry)(RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
67 /* Common Client Interface */
69 #define DEFINE_RDP_CLIENT_COMMON() HANDLE thread
71 struct rdp_client_context
74 DEFINE_RDP_CLIENT_COMMON();
77 /* Common client functions */
79 FREERDP_API rdpContext* freerdp_client_context_new(RDP_CLIENT_ENTRY_POINTS* pEntryPoints);
80 FREERDP_API void freerdp_client_context_free(rdpContext* context);
82 FREERDP_API int freerdp_client_start(rdpContext* context);
83 FREERDP_API int freerdp_client_stop(rdpContext* context);
85 FREERDP_API freerdp* freerdp_client_get_instance(rdpContext* context);
86 FREERDP_API HANDLE freerdp_client_get_thread(rdpContext* context);
88 FREERDP_API int freerdp_client_settings_parse_command_line(rdpSettings* settings, int argc,
89 char** argv, BOOL allowUnknown);
91 FREERDP_API int freerdp_client_settings_parse_connection_file(rdpSettings* settings,
92 const char* filename);
93 FREERDP_API int freerdp_client_settings_parse_connection_file_buffer(rdpSettings* settings,
96 FREERDP_API int freerdp_client_settings_write_connection_file(const rdpSettings* settings,
100 FREERDP_API int freerdp_client_settings_parse_assistance_file(rdpSettings* settings, int argc,
103 FREERDP_API BOOL client_cli_authenticate(freerdp* instance, char** username, char** password,
105 FREERDP_API BOOL client_cli_gw_authenticate(freerdp* instance, char** username, char** password,
107 #if !defined(DEFINE_NO_DEPRECATED)
108 FREERDP_API WINPR_DEPRECATED(DWORD client_cli_verify_certificate(
109 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
110 const char* fingerprint, BOOL host_mismatch));
112 FREERDP_API DWORD client_cli_verify_certificate_ex(freerdp* instance, const char* host,
113 UINT16 port, const char* common_name,
114 const char* subject, const char* issuer,
115 const char* fingerprint, DWORD flags);
116 #if !defined(DEFINE_NO_DEPRECATED)
117 FREERDP_API WINPR_DEPRECATED(DWORD client_cli_verify_changed_certificate(
118 freerdp* instance, const char* common_name, const char* subject, const char* issuer,
119 const char* fingerprint, const char* old_subject, const char* old_issuer,
120 const char* old_fingerprint));
122 FREERDP_API DWORD client_cli_verify_changed_certificate_ex(
123 freerdp* instance, const char* host, UINT16 port, const char* common_name,
124 const char* subject, const char* issuer, const char* fingerprint, const char* old_subject,
125 const char* old_issuer, const char* old_fingerprint, DWORD flags);
127 FREERDP_API BOOL client_cli_present_gateway_message(freerdp* instance, UINT32 type,
128 BOOL isDisplayMandatory,
129 BOOL isConsentMandatory, size_t length,
130 const WCHAR* message);
132 FREERDP_API BOOL client_auto_reconnect(freerdp* instance);
133 FREERDP_API BOOL client_auto_reconnect_ex(freerdp* instance,
134 BOOL (*window_events)(freerdp* instance));
140 #endif /* FREERDP_CLIENT_H */