IWTSSBPlugin interface (tssbx.h)

[The IWTSSBPlugin interface is not supported after Windows Server 2008 R2. Starting with Windows Server 2012 please use the ITsSbPlugin interface.]

Used to extend the capabilities of Terminal Services Session Broker (TS Session Broker). Implement this interface when you want to provide a plug-in that overrides the redirection logic of TS Session Broker.

Inheritance

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

Methods

The IWTSSBPlugin interface has these methods.

 
IWTSSBPlugin::Initialize

Initializes the plug-in and returns a value that indicates the redirection capabilities of the plug-in.
IWTSSBPlugin::Terminated

Notifies the plug-in that it is about to be destroyed by Terminal Services Session Broker (TS�Session Broker).
IWTSSBPlugin::WTSSBX_GetMostSuitableServer

Returns the ID of the server to which Terminal Services Session Broker (TS�Session Broker) should direct the incoming connection.
IWTSSBPlugin::WTSSBX_GetUserExternalSession

Redirects an incoming connection to a computing resource, such as a virtual machine, a blade server, or even the user's own corporate desktop by providing a WTSSBX_MACHINE_CONNECT_INFO structure that contains information about the resource.
IWTSSBPlugin::WTSSBX_MachineChangeNotification

Notifies the plug-in that a change occurred in the server environment.
IWTSSBPlugin::WTSSBX_SessionChangeNotification

Notifies the plug-in that a change, such as a logon, logoff, disconnect, or reconnect, occurred in the session.

Remarks

TS Session Broker calls the WTSSBX_GetUserExternalSession method so that the plug-in can direct an incoming connection to a computer that does not belong to a farm in TS Session Broker.

Alternatively, TS Session Broker calls the WTSSBX_GetMostSuitableServer method so that the plug-in can direct an incoming connection to a computer that does belong to a farm in TS Session Broker.

These methods reference an individual server in the farm by using the unique MachineId assigned to the server by TS Session Broker. When a server joins a farm in TS Session Broker, TS Session Broker calls the WTSSBX_MachineChangeNotification method to notify the plug-in of the change and pass the MachineId of the new server to the plug-in.

Requirements

   
Minimum supported client None supported
Minimum supported server Windows Server 2008
Target Platform Windows
Header tssbx.h

See also

ITsSbPlugin

Remote Desktop Connection Broker Extensibility