ITsSbPlugin interface (sbtsv.h)

Exposes methods that initialize and terminate plug-ins.

This is the base interface for all plug-ins to Remote Desktop Connection Broker (RD Connection Broker). Derive from this interface to create plug-ins for load balancing, placement, or orchestration.

Inheritance

The ITsSbPlugin interface inherits from the IUnknown interface. ITsSbPlugin also has these types of members:

Methods

The ITsSbPlugin interface has these methods.

ITsSbPlugin::Initialize Initializes the plug-in.
ITsSbPlugin::Terminate Performs clean-up and unloads the plug-in.

Remarks

Two different types of plugins are supported - filters and resources. Resource plugins are for supporting new types of resources (for example VMs running on different hypervisors). Filter plugins allow the plugins to change the information passed to other plugins (for example passing resource requests to the least utilized node.)

To register a resource filter, add these values to the registry.

HKEY_LOCAL_MACHINE
   SYSTEM
      CurrentControlSet
         Services
            Tssdis
               Parameters
                  Plugins
                     Resource
                        YOUR_RESOURCE_PLUGIN_NAME
                           CLSID = {CLSID of your resource provider}

                           Data type
                           REG_SZ

                           Provider = Name_of_resource_provider

                           Data type
                           REG_SZ

                           IsEnabled = 1

                           Data type
                           REG_DWORD

The names used should be unique and identify the company, product, and/or feature. They are not shown to the user but can be seen in some logs.

 

To register a filter provider, add these values to the registry.

HKEY_LOCAL_MACHINE
   SYSTEM
      CurrentControlSet
         Services
            Tssdis
               Parameters
                  Plugins
                     Filter
                        1
                           CLSID = {CLSID of filter provider 1}

                           Data type
                           REG_SZ

                           Provider = Name of filter provider 1

                           Data type
                           REG_SZ

                           IsEnabled = 1

                           Data type
                           REG_DWORD

                        2…
                           CLSID = {CLSID of filter provider 2}

                           Data type
                           REG_SZ

                           Provider = Name of filter provider 2

                           Data type
                           REG_SZ

                           IsEnabled = 1

                           Data type
                           REG_DWORD

First the system will load Filter 1, then load Filter 2, etc..

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	sbtsv.h

See also

Remote Desktop Virtualization Interfaces