The Collaboration Broker Client Example
The SDK package comes with a sample command line pre-session client called the Collaboration Broker Client Example, which calls the included broker client libraries and enables you to join a PCoIP collaboration session. The Collaboration Broker Client API Example demonstrates the success path for joining a PCoIP collaboration session.
Session owners generate invitation links and codes on remote Anyware agent machines. These invitations are sent to collaborators, who can join PCoIP sessions using the invitation links and associated codes.
Do not Use the Collaboration Broker Client Example in Production
The Collaboration Broker Client 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 Collaboration Broker Client API is located in the bin/ folder. It contains the broker_client_example_collaborator.exe file, which is the sample command-line client. The other file of importance is login_info_collaborator.txt, which contains authentication information used by the client. login_info_collaborator.txt is available at: examples\broker_client_example.
About the login_info_collaborator.txt File
The Collaborator Broker Client API example uses login_info_collaborator.txt, which is a local text file that provides session input values. The following is a sample login_info_collaborator.txt file:
pcoip://10.11.12.13/connect?data=eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiQWRtaW4iLCJJc3N1ZXIiOiJJc3N1ZXIiLCJVc2VybmFtZSI6IkphdmFJblVzZSIsImV4cCI6MTY3MDYwMTQ1MSwiaWF0IjoxNjcwNjAxNDUxfQ.z8w07IcV5eYbqbYGdjscMVSWFUB4tbU9WrV_V4GWyDU collaborator 123435
In this example:
- The invitation URI is pcoip://10.11.12.13/connect?data=eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiQWRtaW4iLCJJc3N1ZXIiOiJJc3N1ZXIiLCJVc2VybmFtZSI6IkphdmFJblVzZSIsImV4cCI6MTY3MDYwMTQ1MSwiaWF0IjoxNjcwNjAxNDUxfQ.z8w07IcV5eYbqbYGdjscMVSWFUB4tbU9WrV_V4GWyDU
- The Collaborator Name is `collaborator`.
- The Invite Code is 123435.
Remote sessions established by the Collaborator Broker Client Example are the same as collaboration sessions established using the Anyware Software Client, except that the input values are provided by the login_info_collaborator.txt file instead of the Anyware Client.