Documentation Center

Graphics Plugin Administrator Guide

Version 2.1 | Published October 06, 2017 ©

Connection Broker

images/download/attachments/30926753/gui_vcb_configured.png

The Connection Broker is a component that manages a pool of Viz Engines. Clients can query it for a Viz Engine that matches a specific video mode. It provides load balancing, video mode matching and can be used to create a redundant renderer pool.

Note:

The Preview Server is bundled together with the Connection Broker. Both components have their own service document URL, but they share the same pool of Viz Engines. Note that if both services are used extensively, the load on the joint pool may be higher than what is recommended.

This section describes the following Connection Broker-related procedures:

To install the Connection Broker

Note:

The installation requires Microsoft .NET 4.5.

  1. Run the Conection Broker installer file (*.exe) to start the Connection Broker Setup.

  2. Make sure that the Install Location is correctly defined.

  3. Click INSTALL.

    images/download/attachments/30926753/install.png

  4. When the installation is complete, click FINISH.

    images/download/attachments/30926753/install_finish.png

  5. From the Start menu, navigate to All Programs > Vizrt > Connection Broker > Connection Broker Config.

The Connection Broker’s web interface will open if the service is running (address http://localhost:21098/).

Tip:

It is possible to open the Connection Broker configuration from other machines. In order to do so, replace “localhost” with the actual hostname.

To add a Viz Engine to the Connection Broker

  1. In the Connection Broker web interface, enter the Viz Engine hostname or IP address in the text box.

    images/download/attachments/30926753/add_new_engine.png

  2. Click Add New.

Note:

If not specified, the Viz Engine will be added with default port 50010. When using Viz Engines in a so-called dual channel setup, it is possible to run multiple instances of Viz Engine on a single host. Each instance uses a unique port, which means that two Viz Engines should only be considered duplicates when both the hostnames and port numbers are identical. When referring to Viz Engines in a dual channel setup, type the port number after the hostname (for example “VizEngine1:51007”).

To remove a Viz Engine from the Connection Broker

images/download/attachments/30926753/delete_engine.png

  • In the Connection Broker web interface, click the trash can icon next to the Viz Engine entity that is to be removed.

To modify the ping interval from the Connection Broker towards a Viz Engine

  1. Locate the Connection Broker.exe.config file, typically located at C:\Program Files (x86)\Vizrt\Connection Broker.

  2. In the configuration file, set a new value for the VizEnginePollIntervalMilliSeconds option, which controls the interval for how often the Connection Broker will poll each Viz Engine.

  3. Set a new value for the VizEngineTimeoutMilliSeconds option, which controls the timeout in milliseconds when trying to connect to a Viz Engine.

Code example:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
<section name="Vizrt.Frames.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
</sectionGroup>
</configSections>
<applicationSettings>
<Vizrt.Frames.Properties.Settings>
<setting name="VizEnginePollIntervalMilliSeconds" serializeAs="String">
<value>10000</value>
</setting>
<setting name="VizEngineTimeoutMilliSeconds" serializeAs="String">
<value>10000</value>
</setting>
<setting name="CacheMaxAge" serializeAs="String">
<value>86400</value>
</setting>
<setting name="VizEngineCleanupIntervalMilliSeconds" serializeAs="String">
<value>60000</value>
</setting>
<setting name="UseRunLengthEncoding" serializeAs="String">
<value>False</value>
</setting>
</Vizrt.Frames.Properties.Settings>
</applicationSettings>
<system.serviceModel>
<services>
<service behaviorConfiguration="Vizrt.Frames.AtomBrokerService" name="Vizrt.Frames.AtomBrokerService"></service>
</services>
<behaviors>
<serviceBehaviors>
<behavior name="Vizrt.Frames.AtomBrokerService">
<serviceDebug includeExceptionDetailInFaults="true" httpHelpPageEnabled="false" httpsHelpPageEnabled="false" />
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>
<uri>
<schemeSettings>
<add name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes" />
<add name="https" genericUriParserOptions="DontUnescapePathDotsAndSlashes" />
</schemeSettings>
</uri>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
</startup>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Web.Http" publicKeyToken="31bf3856ad364e35" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-5.2.2.0" newVersion="5.2.2.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.Owin" publicKeyToken="31bf3856ad364e35" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-3.0.0.0" newVersion="3.0.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Net.Http.Formatting" publicKeyToken="31bf3856ad364e35" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-5.2.2.0" newVersion="5.2.2.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>