Establishing a PCoIP Session
Brokered Session Connection
If you are using a brokered session, this is handled by the broker libraries automatically.
Before you can establish a PCoIP session with a host desktop, gather the following host desktop details:
- IP address
- Port number
- Session ID
- Server name indication (SNI)
- Connection tag
This information can then be passed to the provided in-session client to establish a PCoIP session programmatically. See the example code for specific call syntax.
Launching a Standalone Client
In terms of programming interface, there are two ways that the connection and security
information can be presented to PCoIPClient.app:
Pass the pieces of information individually to the executable.
The following command invokes PCoIPClient.app to establish a PCoIP session and passes the connection and session information as parameters:
open -a PCoIPClient.app --args -i connect-tag=
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC
8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA address=10.64.60.115
session-id=2305843009213693961
log-id=a1ff3a80-8801-1038-a9bd-00505680aded
where:
-
Connection tag:
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA -
IP address:
10.64.60.115 -
Log ID:
a1ff3a80-8801-1038-19bd-0005680aded -
Session ID:
2305843009213693961
Encode all information into a string container (URI) and then pass to the executable.
The following command invokes pcoip-client to establish a PCoIP session and passes the connection tag as a parameter and a URI encapsulating the IP address and Session ID in a string container:
open -a PCoIPClient.app --args -i connect-tag=
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4A
V1FC8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA "teradicipcoip://
10.64.60.115:4172?session-id=230584300921369396"
where:
-
Connection tag:
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA -
URI: "teradici-pcoip://10.64.60.115:4172?sessionid=230584300921369396"
URI Format Documentation
There is a document describing the URI format in the root of the SDK.
Launching the Client Using a Wrapper Application
While launching the Anyware client using a wrapper application, use the complete path to the client executable along with the optional parameters:
open <Full path to Anyware Client> connect-tag=
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC
8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA address=10.64.60.115
session-id=2305843009213693961
log-id=a1ff3a80-8801-1038-a9bd-00505680aded
where:
-
Complete path: This is the path to the Anyware Client that is relative to the wrapper application.
-
Connection tag:
SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA -
IP address:
10.64.60.115 -
Log ID:
a1ff3a80-8801-1038-a9bd-00505680aded -
Session ID:
2305843009213693961
Info
The wrapper application must have the same permissions as the Anyware client.