Skip to content

Using the Broker Client API Example

The SDK provides a sample command line pre-session client called broker client example. This would enable you to call the included broker client libraries and establish a PCoIP connection. The Broker Client API example demonstrates the success path for establishing new PCoIP sessions.

Do not use the Broker Client API Example in Production

The Broker Client API is provided as an example only, and should not be used in production. The client does not have thorough error handling and does not validate or sanitize user input.

The sample Broker Client API is located here: bin/ There are several files in this directory, but only two are relevant for the broker client example:

  • broker_client_example.exe
  • login_info.txt

The broker_client_example executable is the sample command-line client; the login_info text file contains authentication information used by the client.

About login_info.txt

The Broker Client API example uses a small local text file to supply session input values. The following is a sample login_info.txt file (one line):

sal-w2k8-ch605.autolab.local autolab autorunner mypassword sal-w2k8-ch605
In this example:

  • The FQDN of the host server is sal-w2k8-ch605.autolab.local
  • The Domain is autolab
  • The User is autorunner
  • The Password is mypassword
  • The Host name is sal-w2k8-ch605

Remote sessions established by broker_client_example.exe are exactly the same as sessions established using the PCoIP Software Client, except that the input values are provided by login_info.txt instead of the PCoIP Softare Client’s user interface.