IWTSSBPlugin 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.

Methods

The IWTSSBPlugin interface inherits the methods of the IUnknown interface.

In addition, IWTSSBPlugin defines the following methods.

MethodDescription

Initialize

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

Terminated

Notifies the plug-in that TS Session Broker is about to destroy the plug-in.

WTSSBX_GetMostSuitableServer

Returns the ID of the server to which TS Session Broker should direct the incoming connection.

WTSSBX_GetUserExternalSession

Directs an incoming connection to an external computing resource.

WTSSBX_MachineChangeNotification

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

WTSSBX_SessionChangeNotification

Notifies the plug-in that a change, such as a logon, logoff, disconnect, or reconnect, occurred in a user 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 clientNone supported
Minimum supported serverWindows Server 2008
HeaderTssbx.h
IDLTssbx.idl
IIDIID_IWTSSBPlugin is defined as DC44BE78-B18D-4399-B210-641BF67A002C

See Also

Remote Desktop Connection Broker Extensibility

Send comments about this topic to Microsoft

Build date: 10/19/2009

Tags :


Page view tracker