The Broker Client Example

The included sample broker client demonstrates how the APIs can be used to customize and control the pre-session and session phases of the connection.

Code is an API Demonstration Only

The sample session client, described in the following sections, demonstrates a simple connection scenario using the supplied broker_client_library. The example unrealistically assumes that all requests and calls succeed as expected, and performs only basic error handling. An actual client implementation is likely to be far more complex; for example, you will need to handle failed broker certificate verification, account for other authentication steps beyond a simple user ID and password combination, and any other circumstances dictated by your system requirements.

The following steps outline how to build this example:

  1. Install the SDK.
  2. Create a build/directory inside broker_client_example.
  3. From build/, run cmake configure and build commands.
  4. Update the login_info.txt with the address and credentials of an authentic agent so that the built client can talk to the agent.
  5. Run the broker_client_example application. It should be able to launch a brokered PCoIP Session to the agent by invoking the session_client.exe.

The Broker Client API Example Sequence

This section describes how the broker client API example implements the PCoIP session sequence. It also provides an overview of invoking and using the executable session client.

Custom Broker Client Library Implementations

PCoIP clients interact with PCoIP-compatible brokers and PCoIP agents using an abstraction layer called a broker client library. The following example uses the supplied broker client library. You may, however, choose to write your own broker client library to meet specific requirements, or use a thirdparty broker library which does not use the PCoIP Broker Protocol. Refer to the PCoIP® Connection Broker Protocol Specification for details on how to design and implement your own connection broker.