#include <freerdp/api.h>
#include <freerdp/wts_services.h>

This graph shows which files directly or indirectly include this file:

Data Structures
struct	WINDOW_INFO_SOURCE
	what the client gives the service to answer from More...

Functions
WINPR_ATTR_NODISCARD FREERDP_API IWTSWindowInfoService *	freerdp_client_window_info_service_new (const WINDOW_INFO_SOURCE *source)
	a new service (one reference for the caller) answering from `source`, which is copied

FREERDP_API void	freerdp_client_window_info_service_changed (IWTSWindowInfoService *service, UINT64 remoteHwnd)
	a window changed (moved, resized, scaled, shown or hidden): the subscriber gets its new WTS_WINDOW_INFO (remoteHwnd: the remote window in a RemoteApp session, 0 for the desktop). Calls the subscriber on the calling thread.

FREERDP_API void	freerdp_client_window_info_service_detach (IWTSWindowInfoService *service)
	stops using `source`: from now on the service answers E_UNEXPECTED. To call before what `source` uses goes, since channels and plugins may keep the service.

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation IWTSWindowInfoService for clients

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 IWTSWindowInfoService a client puts in rdpContext::windowInfoService, with Microsoft's behaviour (one subscriber, synchronous Subscribe/Unsubscribe, OnWindowChanged given a copy of the new WTS_WINDOW_INFO, GetProcessId the client's process). The client only tells where its windows are.

WINDOW_INFO_SOURCE source = { me, get_window_info, get_session_type }; context->windowInfoService = freerdp_client_window_info_service_new(&source); ... // each time a window moves, resizes or changes scale: freerdp_client_window_info_service_changed(context->windowInfoService, 0); ... // in ContextFree, before me goes: freerdp_client_window_info_service_detach(context->windowInfoService); WINPR_COM_RELEASE(context->windowInfoService); context->windowInfoService = nullptr;

Since: version 3.34.0

Definition in file window_info_service.h.

Function Documentation

◆ freerdp_client_window_info_service_changed()

FREERDP_API void freerdp_client_window_info_service_changed	(	IWTSWindowInfoService *	service,
		UINT64	remoteHwnd
	)

a window changed (moved, resized, scaled, shown or hidden): the subscriber gets its new WTS_WINDOW_INFO (remoteHwnd: the remote window in a RemoteApp session, 0 for the desktop). Calls the subscriber on the calling thread.

Since: version 3.34.0

Definition at line 178 of file window_info_service.c.

{
  CWindowInfoService* s = (CWindowInfoService*)service;
  if (!s)
    return;
 
  WTS_WINDOW_INFO info = WINPR_C_ARRAY_INIT;
  IWTSWindowChangedCallback* callback = nullptr;
  EnterCriticalSection(&s->lock);
  const WINDOW_INFO_SOURCE* src = source_locked(s);
  if (src && s->subscriber && SUCCEEDED(src->GetWindowInfo(src->custom, remoteHwnd, &info)))
  {
    callback = s->subscriber;
    WINPR_COM_ADDREF(callback);
  }
  LeaveCriticalSection(&s->lock);
 
  if (!callback)
    return;
  /* outside the lock: the subscriber may call the service back */
  const HRESULT hr = callback->lpVtbl->OnWindowChanged(callback, &info);
  if (FAILED(hr))
    WLog_DBG(TAG, "OnWindowChanged failed: 0x%08" PRIX32, (UINT32)hr);
  WINPR_COM_RELEASE(callback);
}

◆ freerdp_client_window_info_service_detach()

FREERDP_API void freerdp_client_window_info_service_detach ( IWTSWindowInfoService * service )

stops using source: from now on the service answers E_UNEXPECTED. To call before what source uses goes, since channels and plugins may keep the service.

Since: version 3.34.0

Definition at line 204 of file window_info_service.c.

{
  CWindowInfoService* s = (CWindowInfoService*)service;
  if (!s)
    return;
  EnterCriticalSection(&s->lock);
  s->detached = TRUE;
  LeaveCriticalSection(&s->lock);
}

◆ freerdp_client_window_info_service_new()

WINPR_ATTR_NODISCARD FREERDP_API IWTSWindowInfoService * freerdp_client_window_info_service_new ( const WINDOW_INFO_SOURCE * source )

a new service (one reference for the caller) answering from source, which is copied

Since: version 3.34.0

Definition at line 158 of file window_info_service.c.

{
  WINPR_ASSERT(source);
  WINPR_ASSERT(source->GetWindowInfo);
  WINPR_ASSERT(source->GetSessionType);
 
  CWindowInfoService* s = calloc(1, sizeof(*s));
  if (!s)
    return nullptr;
  if (!InitializeCriticalSectionAndSpinCount(&s->lock, 4000))
  {
    free(s);
    return nullptr;
  }
  winpr_com_base_init(&s->com, "CWindowInfoService", &CWindowInfoService_vtbl.iunknown,
                      CWindowInfoService_free);
  s->source = *source;
  return (IWTSWindowInfoService*)s;
}

References WINDOW_INFO_SOURCE::GetSessionType, WINDOW_INFO_SOURCE::GetWindowInfo, and winpr_com_base_init().

Here is the call graph for this function:

Data Structures

Functions

Detailed Description

Function Documentation

◆ freerdp_client_window_info_service_changed()

◆ freerdp_client_window_info_service_detach()

◆ freerdp_client_window_info_service_new()