dvc.h

 
#ifndef FREERDP_DVC_H
#define FREERDP_DVC_H
 
#include <freerdp/types.h>
#include <freerdp/addin.h>
#include <freerdp/settings.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
  typedef struct s_IWTSVirtualChannelManager IWTSVirtualChannelManager;
  typedef struct s_IWTSListener IWTSListener;
  typedef struct s_IWTSVirtualChannel IWTSVirtualChannel;
 
  typedef struct s_IWTSPlugin IWTSPlugin;
  typedef struct s_IWTSListenerCallback IWTSListenerCallback;
  typedef struct s_IWTSVirtualChannelCallback IWTSVirtualChannelCallback;
 
  struct s_IWTSListener
  {
    /* Retrieves the listener-specific configuration. */
    WINPR_ATTR_NODISCARD UINT (*GetConfiguration)(IWTSListener* pListener,
                                                  void** ppPropertyBag);
 
    void* pInterface;
  };
 
  struct s_IWTSVirtualChannel
  {
    /* Starts a write request on the channel. */
    WINPR_ATTR_NODISCARD UINT (*Write)(IWTSVirtualChannel* pChannel, ULONG cbSize,
                                       const BYTE* pBuffer, void* pReserved);
    /* Closes the channel. */
    WINPR_ATTR_NODISCARD UINT (*Close)(IWTSVirtualChannel* pChannel);
  };
 
  struct s_IWTSVirtualChannelManager
  {
    /* Returns an instance of a listener object that listens on a specific
       endpoint, or creates a static channel. */
    WINPR_ATTR_NODISCARD UINT (*CreateListener)(IWTSVirtualChannelManager* pChannelMgr,
                                                const char* pszChannelName, ULONG ulFlags,
                                                IWTSListenerCallback* pListenerCallback,
                                                IWTSListener** ppListener);
    /* Find the channel or ID to send data to a specific endpoint. */
    WINPR_ATTR_NODISCARD UINT32 (*GetChannelId)(IWTSVirtualChannel* channel);
    WINPR_ATTR_NODISCARD IWTSVirtualChannel* (*FindChannelById)(
        IWTSVirtualChannelManager* pChannelMgr, UINT32 ChannelId);
    WINPR_ATTR_NODISCARD const char* (*GetChannelName)(IWTSVirtualChannel* channel);
    UINT (*DestroyListener)(IWTSVirtualChannelManager* pChannelMgr, IWTSListener* ppListener);
  };
 
  struct s_IWTSPlugin
  {
    /* Used for the first call that is made from the client to the plug-in. */
    WINPR_ATTR_NODISCARD UINT (*Initialize)(IWTSPlugin* pPlugin,
                                            IWTSVirtualChannelManager* pChannelMgr);
    /* Notifies the plug-in that the Remote Desktop Connection (RDC) client
       has successfully connected to the Remote Desktop Session Host (RD
       Session Host) server. */
    WINPR_ATTR_NODISCARD UINT (*Connected)(IWTSPlugin* pPlugin);
    /* Notifies the plug-in that the Remote Desktop Connection (RDC) client
       has disconnected from the RD Session Host server. */
    WINPR_ATTR_NODISCARD UINT (*Disconnected)(IWTSPlugin* pPlugin, DWORD dwDisconnectCode);
    /* Notifies the plug-in that the Remote Desktop Connection (RDC) client
       has terminated. */
    WINPR_ATTR_NODISCARD UINT (*Terminated)(IWTSPlugin* pPlugin);
 
    WINPR_ATTR_NODISCARD UINT (*Attached)(IWTSPlugin* pPlugin);
 
    WINPR_ATTR_NODISCARD UINT (*Detached)(IWTSPlugin* pPlugin);
 
    /* Extended */
 
    void* pInterface;
  };
 
  struct s_IWTSListenerCallback
  {
    /* Accepts or denies a connection request for an incoming connection to
       the associated listener. */
    WINPR_ATTR_NODISCARD
    UINT (*OnNewChannelConnection)(IWTSListenerCallback* pListenerCallback,
                                   IWTSVirtualChannel* pChannel, BYTE* Data, BOOL* pbAccept,
                                   IWTSVirtualChannelCallback** ppCallback);
 
    void* pInterface;
  };
 
  struct s_IWTSVirtualChannelCallback
  {
    WINPR_ATTR_NODISCARD UINT (*OnDataReceived)(
        IWTSVirtualChannelCallback* pChannelCallback,
        wStream* data); 
    WINPR_ATTR_NODISCARD UINT (*OnOpen)(
        IWTSVirtualChannelCallback*
            pChannelCallback); 
    WINPR_ATTR_NODISCARD UINT (*OnClose)(
        IWTSVirtualChannelCallback*
            pChannelCallback); 
    void* pInterface;
  };
 
  /* The DVC Plugin entry points */
  typedef struct rdp_context rdpContext; /* forward declaration, necessary to avoid
                                          * circular includes */
 
  typedef struct S_IDRDYNVC_ENTRY_POINTS IDRDYNVC_ENTRY_POINTS;
  struct S_IDRDYNVC_ENTRY_POINTS
  {
    WINPR_ATTR_NODISCARD UINT (*RegisterPlugin)(IDRDYNVC_ENTRY_POINTS* pEntryPoints,
                                                const char* name, IWTSPlugin* pPlugin);
    IWTSPlugin* (*GetPlugin)(IDRDYNVC_ENTRY_POINTS* pEntryPoints, const char* name);
    const ADDIN_ARGV* (*GetPluginData)(IDRDYNVC_ENTRY_POINTS* pEntryPoints);
    WINPR_ATTR_NODISCARD rdpSettings* (*GetRdpSettings)(IDRDYNVC_ENTRY_POINTS* pEntryPoints);
    WINPR_ATTR_NODISCARD rdpContext* (*GetRdpContext)(IDRDYNVC_ENTRY_POINTS* pEntryPoints);
  };
 
  typedef UINT(VCAPITYPE* PDVC_PLUGIN_ENTRY)(IDRDYNVC_ENTRY_POINTS*);
 
  WINPR_ATTR_NODISCARD
  FREERDP_API void* get_callback_by_name(const char* name, void** context);
  FREERDP_API void add_callback_by_name(const char* name, void* fkt, void* context);
  FREERDP_API void remove_callback_by_name(const char* name, void* context);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FREERDP_DVC_H */