Documentation for Ice 3.6. The documentation for Ice 3.5 and Ice 3.4 is available in separate spaces.

Skip to end of metadata
Go to start of metadata

This page provides important information for users of the Ice binary distribution on Windows platforms.

On this page:

Overview of the Windows binary distribution

The Ice binary distribution for Windows provides the Ice run-time and SDKs for the following programming languages and platforms:

  • for C++, using Visual Studio 2012 or Visual Studio 2013
  • for .NET, using Visual Studio 2012 or Visual Studio 2013
  • for Java, using Java 7 or Java 8
  • for Android, using Android 4.2 or later
  • for PHP, using PHP 5.6

You only need the development environment for your target programming language to use this distribution. For example, if you want to build Ice applications in Java, you need to install a JDK, but do not need to install Visual Studio or PHP.

Ice Builders

Icon

You should also install the Ice Builder for your development environment, such as the Ice Builder for Visual Studio or the Ice Builder for Gradle. These Ice Builders are not included in the Windows binary distribution, and typically support several versions of Ice.

C++ run-time

Icon

The Ice binary distribution for Windows installs the Visual Studio 2013 32-bit C++ run-time on your computer. It does not install any other C++ run-time.

This allows you to execute all C++ programs installed in the main bin directory (such as icegridregistry.exe and slice2java.exe) without having to install Visual Studio 2013 or the Visual Studio 2013 C++ x64 redistributable package. However, if you want to execute C++ programs installed in the bin subdirectories, such as bin\x64\icegridregistry.exe or bin\vc110\icegridregistry.exe, you need to install the corresponding Visual Studio C++ redistributable package.

Setting up your Windows environment to use Ice

After installing Ice, read the relevant language-specific sections below to learn how to configure your environment and start programming with Ice.

Please note that the instructions below assume that Ice was installed in the default location C:\Program Files (x86)\ZeroC\Ice-3.6.0.

C++

To use Ice for C++ you need to add one or more of the Ice bin directories to your PATH. The changes you must make depend on your compiler and architecture, as listed below:

  • Visual Studio 2013, 32-bit

    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin;%PATH%
    
  • Visual Studio 2013, 64-bit

    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin;%PATH%
    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\x64;%PATH%
    

    The x64 directory must come first in your PATH.

  • Visual Studio 2012, 32-bit

    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\vc110;%PATH%
    
  • Visual Studio 2012, 64-bit

    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\vc110;%PATH%
    set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\vc110\x64;%PATH%
    

    The x64 directory must come first in your PATH.

If you don't want to rely on the PATH environment variable to locate the Ice for C++ DLLs, you can also copy the DLLs into the same directory as your executable.

Compiler Flags

The Release versions of the Ice libraries are compiled with /MD to select the multi-threaded Visual C++ run-time library, while the Debug versions use /MDd to select the debug multi-threaded run-time library. Both versions of the Ice libraries are compiled with /EHsc to select an exception handling model.

Your application must be compiled with the same flags as the Ice libraries:

  • Release: /MD /EHsc
  • Debug: /MDd /EHsc

Import Libraries

You no longer need to list Ice import libraries such as IceD.lib when linking with Ice libraries. See Linking with C++ Libraries on Windows for additional details. 

.NET

Locating the .NET assemblies

To use Ice for .NET, you can either copy the .NET assemblies to the directory of your executable or add the .NET assemblies to the Global Assembly Cache (GAC).

Copying the Ice for .NET assemblies to the executable directory is the simplest solution. You can set up your Visual Studio projects to copy the assemblies by setting the Copy Local property to True. To access this property in the Solution Explorer, open the References folder of your project and click on the assembly to access its properties in the Properties panel.

You can also add the Ice for .NET assemblies to the GAC. To do this, open a command prompt window with Administrator privileges and use gacutil:

gacutil /i <library.dll>

The gacutil tool is included with your Visual Studio installation. You can find which gacutil you are using with the where command, for example:

where gacutil
C:\Program Files (x86)\Microsoft SDKs\Windows\v8.1A\bin\NETFX 4.5.1 Tools\x64\gacutil.exe

Once installed in the GAC, the assemblies will always be located correctly without having to set environment variables or copy them into the same directory as an executable.

Line numbers for stack traces

If you've installed the Ice assemblies in the GAC and want line numbers for stack traces, you must also install the PDB (.pdb) files in the GAC. Unfortunately, you cannot do this using Explorer, so you have to do it from the command line. Open a command shell window and navigate to C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Ice (assuming C:\Windows is your system root). Doing a directory listing there, you will find a directory named v4.0_3.6.0.0__<UUID>, for example:

v4.0_3.6.0.0__cdd571ade22f2f16

Change to that directory (making sure that you use the correct version number for this release of Ice). In this directory, you will see the Ice.dll you installed into the GAC in the preceding step. Now copy the Ice.pdb file into this directory:

copy C:\Program Files (x86)\ZeroC\Ice-3.6.0\Assemblies\Ice.pdb

Using protocol compression

The Ice for .NET run time implements protocol compression by dynamically loading the native library bzip2.dll from a directory in your PATH. Ice disables the protocol compression feature if it is unable to load the bzip2 library successfully.

This DLL is included in your Ice distribution, therefore the Ice bin directory must be added to your PATH:

set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin;%PATH%

On 64-bit Windows, use the following setting instead:

set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\x64;%PATH%

If the wrong PATH is set, the Ice run time prints a warning to the console when it detects a bzip2.dll format mismatch during start-up.

Using managed code in .NET

The main Ice for .NET assembly (Ice.dll) included in the Windows binary distribution uses unmanaged code. If you require only managed code then you can clone the ice repository and build Ice for .NET in a purely managed version. Note that the managed version of Ice for .NET omits support for protocol compression and for signal handling in the Ice.Application class.

Java

JAR Files

The preferred way to use Ice for Java is to configure your build environment to fetch the build artifacts from the ZeroC Maven repository located at:

http://repo.zeroc.com/nexus/content/repositories/releases

The Maven package ids are as follows:

  • groupId=com.zeroc, version=3.6.0, artifactId=ice, 
  • groupId=com.zeroc, version=3.6.0, artifactId=freeze
  • groupId=com.zeroc, version=3.6.0, artifactId=glacier2
  • groupId=com.zeroc, version=3.6.0, artifactId=icebox
  • groupId=com.zeroc, version=3.6.0, artifactId=icediscovery
  • groupId=com.zeroc, version=3.6.0, artifactId=icegrid
  • groupId=com.zeroc, version=3.6.0, artifactId=icelocatordiscovery
  • groupId=com.zeroc, version=3.6.0, artifactId=icepatch2
  • groupId=com.zeroc, version=3.6.0, artifactId=icestorm

If you cannot fetch the Ice for Java artifacts from the ZeroC Maven repository, the Ice JAR files are also installed locally in C:\Program Files (x86)\ZeroC\Ice-3.6.0\lib. The Ice JAR files are named as follows:

  • ice-3.6.0.jar
  • freeze-3.6.0.jar
  • glacier2-3.6.0.jar
  • icebox-3.6.0.jar
  • icediscovery-3.6.0.jar
  • icegrid-3.6.0.jar
  • icelocatordiscovery-3.6.0.jar
  • icepatch2-3.6.0.jar
  • icestorm-3.6.0.jar

Freeze and Berkeley DB

In order to use Freeze for Java, you need to add both freeze-3.6.0.jar and the Berkeley DB jar file (db.jar) to your build path. db.jar is installed alongside the Ice jar files in C:\Program Files (x86)\ZeroC\Ice-3.6.0\lib.

At run time, the JVM requires that the directory containing Berkeley DB's native libraries be included in java.library.path, which corresponds to the PATH environment variable on Windows.

With a 32-bit JVM, update your PATH as follows:

set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin;%PATH%

For a 64-bit JVM, use the following setting instead:

set PATH=C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\x64;%PATH%

Bzip2

Ice for Java supports protocol compression using the bzip2 classes included with ant. Compression is automatically enabled if these classes are present in your CLASSPATH. You can either add ant.jar to your CLASSPATH, or download only the bzip2 classes from http://www.kohsuke.org/bzip2.

You can also retrieve this bzip2 jar file from ZeroC's Maven repository located at http://repo.zeroc.com/nexus/content/repositories/thirdparty.

The Maven package id for the bzip2 jar file is as follows:

  • groupId=org.apache.tools, version=1.0, artifactId=bzip2

Icon

These classes are a pure Java implementation of the bzip2 algorithm and therefore add significant latency to Ice requests.

PHP

The Ice extension for PHP included in this installer is compiled with VC11 for compatibility with the PHP binary distribution. To use this extension, you will need a compatible PHP binary distribution as well as a compatible Web server. If you wish to use Apache, you can obtain a VC11 build of Apache from alternate sources as Apache does not provide a VC11 build (PHP recommends the builds by Apache Lounge).

If you require a version of the Ice extension for a different environment, you will need to compile the extension from source. Clone the ice repository and review the php/INSTALL file for details.

We provide instructions below for configuring PHP to use the Ice extension. Please defer to your web server's instructions to configure it to run PHP. These instructions make several assumptions:

  • PHP is installed in C:\PHP
  • C:\PHP is in your system path
  • Ice is installed in C:\Program Files (x86)\ZeroC\Ice-3.6.0

If you have a different installation, you will need to make the appropriate changes as you follow the instructions.

1. Determine the location of your PHP configuration file

Check for the location of your php.ini file by examining the output of the php -i command, or by calling the phpinfo() function from a script, for the line Loaded Configuration File. For example:

C:\PHP\php.ini

If no file has been loaded then you will need to create one. PHP provides templates for development and production use:

  • C:\PHP\php.ini-development
  • C:\PHP\php.ini-production

Depending on your environment, copy the correct file to a new file, C:\PHP\php.ini, and configure it as needed. Verify that it is loaded as described above.

As an administrator, open the php.ini in a text editor and append the following line:

extension = php_ice.dll

The file php_ice.dll contains the Ice extension for PHP.

2. Install the Ice extension DLL

Look for the extension_dir setting in the output of the command php -i:

extension_dir = "C:\PHP\ext"

If instead the extension_dir setting contains a relative path, it is resolved relative to the working directory of the web server process (For example, Apache's working directory is usually its installation directory.)

Copy the DLL for the Ice extension to PHP's extension directory:

copy "C:\Program Files (x86)\ZeroC\Ice-3.6.0\php\php_ice.dll" "C:\PHP\ext"

3. Verify that the dependent libraries can be loaded

Regardless of the location of PHP's extension directory, the Ice extension's dependent libraries must be located in the executable search path of the calling process, either your web server or directly from the command line.

The Ice extension depends on the following libraries:

  • bzip2.dll
  • ice36.dll
  • iceutil36.dll
  • slice36.dll

All of these files can be found in the bin subdirectory of your Ice installation (e.g., C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\vc110). To add the Ice installation directory to the system PATH, open  the System control panel and change the system PATH to include C:\Program Files (x86)\ZeroC\Ice-3.6.0\bin\vc110. Note that Windows must be restarted for this change to take effect.

If you're using Apache and it cannot find or access a DLL, Apache startup may fail with an access violation, or the PHP module may ignore the Ice extension and continue its initialization. Consequently, a successful Apache startup does not necessarily mean that the Ice extension has been loaded. Unfortunately, the message reported by PHP in Apache's error log is not very helpful; the error might imply that it cannot find php_ice.dll when in fact it was able to open php_ice.dll but a dependent DLL was missing or inaccessible.

4. Review access rights

Review the access rights on PHP's extension directory, the Ice extension DLL, and its dependent libraries. For example when running as a Windows service, Apache runs in the Local System account (also known as NT Authority\SYSTEM). You can use the cacls utility in a command window to view and modify access rights. For example, run the following commands to review the current access rights of the Ice extension:

cd \PHP\ext
cacls php_ice.dll

5. Locate the Ice run-time files

Your application will also need to include at least some of the Ice for PHP run-time source files (installed in C:\Program Files (x86)\ZeroC\Ice-3.6.0\php). To make these files available to your application, you can either modify PHP's include path or copy the necessary files to a directory that is already in the interpreter's include path. You can determine the current include path by running the command php -i and searching for an entry named include_path.

If you want to make the Ice run-time files available to all PHP applications on the host, you can modify the include_path setting in php.ini to add the installation directory:

include_path = C:\Program Files (x86)\ZeroC\Ice-3.6.0;...

Another option is to modify the include path from within your script prior to including any Ice run-time file:

PHP
ini_set('include_path', ini_get('include_path') . PATH_SEPARATOR . 'C:/Program Files (x86)/ZeroC/Ice-3.6.0/php')
require 'Ice.php'; // Load the core Ice run time definitions.

Using the sample programs on Windows

The Ice sample programs are provided in a GitHub repository. You can browse this repository to see build and usage instructions for all supported programming languages.

During installation, you can choose to install the sample programs for all supported programming languages in a folder of your choice (by default a sub-folder of your Documents folder). You'll then find a shortcut to this folder in your Start menu.

Alternatively, you can clone the ice-demos repository and use its 3.6 branch:

git clone -b 3.6 https://github.com/zeroc-ice/ice-demos.git
cd ice-demos

Configuration files for IceGrid and Glacier2 services

The config subdirectory of your Ice installation includes sample configuration files for the Glacier2 router, IceGrid node, and IceGrid registry. These files provide a good starting point on which to base your own configurations, and they contain comments that describe the settings in detail.

If you intend to edit one of the configuration files but you have installed your distribution into \Program Files or \Program Files (x86) on Windows Vista or later, be aware that Windows makes it difficult to make permanent modifications to files in these directories. We recommend copying the files to the location of your choice. For more information on this topic, refer to the Virtualization section of New UAC Technologies for Windows Vista.

The Ice manual provides more information on installing and running the IceGrid registry, IceGrid node, and Glacier2 router as Windows services.

Starting the IceGrid Administrative Console on Windows

You can launch the IceGrid Administrative Console using the shortcut that the Ice installer created in your Start menu as IceGrid Admin. The console is a Java program and requires JRE 7u6 or later.

Ice installer registry key

The Ice installer adds information to the Windows registry to indicate where it was installed. Developers can use this information to locate the Ice files in their applications.

The registration key used by this installer is:

HKEY_LOCAL_MACHINE\Software\ZeroC\Ice 3.6.0

The install location is stored as a string value named InstallDir.

Third-party packages for Windows

The binary distribution for Windows includes the following third-party packages as separate binaries:

  • Berkeley DB 5.3.28 (C/C++ and Java run-time)
  • Bzip2 1.0.6 (C run-time)
  • Expat 2.1.0 (C run-time)

  • No labels