IceIce
Home
  • Getting Started

    • Quick Start
    • Core Concepts
    • Architecture
  • SDK Guide

    • Java SDK
    • Go SDK
    • Python SDK
  • Reference

    • Node Types
    • Roam API
    • Server Config
    • Client Config
Playground
FAQ
  • Changelog
  • Upgrade Guide
Sponsor
Community
GitHub
  • English
  • 简体中文
Home
  • Getting Started

    • Quick Start
    • Core Concepts
    • Architecture
  • SDK Guide

    • Java SDK
    • Go SDK
    • Python SDK
  • Reference

    • Node Types
    • Roam API
    • Server Config
    • Client Config
Playground
FAQ
  • Changelog
  • Upgrade Guide
Sponsor
Community
GitHub
  • English
  • 简体中文
  • Reference

    • Node Types
    • Roam API
    • Server Config
    • Client Config

Client Configuration Reference

Ice Client is configured through constructor parameters. The following parameters have consistent semantics across the Java, Go, and Python SDKs.

Common Parameters

ParameterTypeRequiredDefaultDescription
appintYes--App ID, corresponding to the App created in Server
storagePathstringYes--Shared storage path, must point to the same ice-data directory as Server
scanstringJava only--Leaf node scan package path. Go/Python use explicit registration and do not need this parameter
parallelismintNo-1Thread pool size for parallel nodes. <=0 uses framework default
pollIntervalint/DurationNo5sVersion file poll interval
heartbeatIntervalint/DurationNo10s (Java) / 30s (Go/Python)Heartbeat reporting interval
lanestringNoemptyLane name. Empty string means main trunk. Used for traffic isolation and branch testing

Initialization Examples

Lane

Lanes are used for traffic isolation and are suitable for the following scenarios:

  • Branch isolation testing in development environments
  • A/B testing with different rule versions
  • Canary releases

A Client with a lane configured will prioritize loading lane-specific configurations; nodes not configured in the lane fall back to the main trunk configuration.

Edit this page on GitHub
Prev
Server Config