znsocket documentation

znsocket is a Python and JavaScript library that provides Redis-compatible API using websockets. It enables real-time synchronization of data structures between multiple clients and supports distributed applications with automatic reconnection capabilities.

Key features:

• Distributed data structures: List, Dict, and Segments that sync across clients

• Nested structures: Lists can contain Dicts, Dicts can contain Lists, and Segments work with both

• Real-time synchronization: Changes are immediately visible to all connected clients

• Cross-language support: Use the same data structures from Python and JavaScript

• Adapter pattern: Expose existing data structures through the znsocket interface

• Automatic chunking: Large messages are automatically split and reassembled for reliable transmission

• Copy-on-write operations: Efficient data copying using Segments and fallback mechanisms

Contents:

• Quick Start
  • Installation
  • Basic Usage
• Automatic Message Chunking
  • Overview
  • How It Works
  • Configuration Options
  • Example Usage
  • Performance Considerations
  • Monitoring Chunking
  • Troubleshooting
• Copy-on-Write Operations
  • Overview
  • Implementation Approaches
  • Segments: True Copy-on-Write
  • List Fallbacks: Transparent Copy-on-Write
  • JavaScript Integration
  • Use Cases and Patterns
  • Performance Considerations
  • Best Practices
  • Error Handling and Edge Cases
  • Troubleshooting
• Python API
  • Client
  • Server
  • Storage
  • List
  • Dict
  • ListAdapter
  • DictAdapter
  • Segments
  • Functions
• JavaScript API
  • Client
  • List
  • Dict
  • Segments
• Examples
  • Real-time Chat Application
  • Distributed Task Queue
  • Shared Configuration
  • Data Synchronization with Adapters
  • Nested Data Structures
  • Segments for Large Data
• Development