Skip to content

About the Anyware Client SDK for Linux

The Client SDK for Linux does not ship with its own session client binary; it uses the standard Anyware Software Client for Linux binary instead. Therefore, you must first download and install the Anyware client application, and then invoke it from the SDK.

Important: If you have used previous versions of the Client SDK for Linux

Prior to the 23.01 release, the Client SDK for Linux shipped with an included session client binary. If you are coming from a previous release, you should install the Anyware Software Client for Linux, and update your code to use the new file location.

Invoking the Anyware client

  1. Ensure that you installed the Anyware client. For more information, see "Installing the Anyware Software Client for Linux" in the Anyware Software Client for Linux Administrators' Guide.

  2. Invoke the in-session Anyware client from the Command-line using the following command:

    /usr/bin/pcoip_client --log-id [log-id] --connect-tag [connect-tag] --sni [sni] --session-id [session-id] --port [port] --address [ip-address]

    Where the following parameters can be configured:

    • log-id
    • connect-tag
    • sni
    • session-id
    • port
    • ip-address

    Parameters descriptions are available in the topic "Configurable Settings" in the Anyware Software Client for Linux Administrators' Guide.

    In this example command, the log ID is set to abcde1234 at the time of invoking the in-session Anyware client:

    /usr/bin/pcoip_client --log-id abcde1234

  3. Complete the configuration. After the PCoIP connection is established, several options are available from the in-session client. For details, see the URI configuration options described in the Anyware Software Client for Linux Administrators' Guide.

Note: Information on Out-of-the-box Examples

The Client SDK for Linux comes with the Broker Client Example and the Collaboration Broker Client Example out of the box. The following topics contain instructions on invoking these examples:

Listing the SDK Package Files

  1. Fetch the latest .deb package for the SDK by running the following command:

    apt-get download pcoip-client-sdk

  2. To list the contents of the SDK package, run the following command: 

    dpkg -c <package name>

    For example, in this command, pcoip-client-sdk_23.04.1-18.04_amd64.deb represents the name of the SDK package:

    dpkg -c pcoip-client-sdk_23.04.1-18.04_amd64.deb