Vix.cpp Documentation

Vix.cpp v2.8.4 is here Read the blog

Vix.cpp

Main Navigation Download PDF Registry

Appearance

Sidebar Navigation

Start Here

Welcome to Vix.cpp

What is Vix.cpp?

Installation

Set Up Your Environment

Run Your First C++ File

Create Your First Project

Your First HTTP Server

Concepts

Why Vix Exists

Mental Model

Workflow

Project Model

Runtime

Vix and CMake

Modules and Composition

Local to Production

Projects

vix.app

Overview

Getting Started

Project Types

Manifest Reference

Sources and Includes

Packages and Links

Resources

Output Directory

Compile Options

Libraries

App Modules

Tests

Examples

Migrating from CMake

CMake Fallback

Best Practices

Troubleshooting

Application Modules

Overview

Why Application Modules

Getting Started

Module Layout

Module Manifest

CLI Workflow

Dependencies and Checks

Tests

Generated Registration

Backend Modules

Using with vix.app

Using with CMake

Best Practices

Troubleshooting

Templates

Overview

Application

Overview

Generated Layout

Module Registry

Manifest

Backend

Overview

Generated Layout

App Bootstrap

Routes and Middleware

Modules Integration

Production Files

Web

Overview

Generated Layout

Rendering Flow

Routes and Views

Production Files

Vue.js

Overview

Generated Layout

Frontend Workflow

Backend Integration

Game

Overview

Generated Layout

Assets and Package

Manifest

Library

Overview

Generated Layout

Examples and Tests

CMake Package

Registry Metadata

Dependencies

Testing

Existing CMake Projects

Production

Vix Modules

Core

Overview

App

Architecture

Routing

Handlers

Middleware

Request

Response

Static files

Templates

HTTP server

Sessions

Transports

TLS

Runtime executor

Async and runtime

Configuration

Print

Format

Console

Input

Inspect

OpenAPI

Attached runtime

API Reference

Error

Overview

Result

Error Object

Error Codes

Error Categories

Exception Bridge

API Reference

Conversion

Overview

Quick Start

Expected Results

Errors

Integers

Floats

Booleans

Enums

To String

Generic Parse

API Reference

Validation

Overview

Quick Start

Results

Errors

Rules

Single Field Validation

Parsed Validation

Schemas

Base Models

Forms

API Reference

Tests

Overview

Quick Start

Assertions

Test Cases

Test Suites

Registry

Runner

Summaries

Colors and Output

Timers

CLI

CMake

API Reference

Crypto

Overview

Quick Start

Results and Errors

Random

Hashing

HMAC

Bytes and Hex

Constant-Time Compare

Passwords

KDF

Keys

AEAD

Signatures

Certificates

CMake

API Reference

FS

Overview

Quick Start

Paths and Results

Read and Write

Directories

Listing

Copy, Move, and Remove

Metadata

Options

Errors

API Reference

Path

Overview

Quick Start

Lexical Paths

Join and Normalize

Path Components

Absolute and Relative

Separators and Styles

Options

Errors

API Reference

OS

Overview

Quick Start

Platform and Architecture

User and Process

Directories

System Resources

Sleep

Errors

API Reference

Process

Overview

Quick Start

Commands

Options and Pipes

Spawn and Child

Output

Status and Wait

Terminate and Kill

Pipelines

Async

Errors

CMake

API Reference

IO

Overview

Quick Start

Input and Output

Read and Write

Lines

Buffers

Copy

Standard Streams

Options

Errors

API Reference

Env

Overview

Quick Start

Process Environment

Typed Values

.env Files

Parsing

Layered Loading

Load Into Process

Options

Errors

API Reference

Time

Overview

Quick Start

Durations

Timestamps

Clocks

Dates

DateTime

Parsing

Chrono Interop

API Reference

Async

Overview

io_context

Tasks

Spawn

Timers

Cancellation

Thread pool

when_all / when_any

Signals

TCP

UDP

DNS

API Reference

ThreadPool

Overview

Quick Start

Installation

Concepts

Tasks

Futures

Cancellation

Timeouts

Priorities

Task Groups

Shutdown

Metrics

Periodic Tasks

Parallel For

Parallel Map

Parallel Reduce

Best Practices

API Reference

Middleware

Overview

Quick Start

App Integration

Core Concepts

Basics

Security

Authentication

Parsers

HTTP Cache

Performance

Observability

API Reference

Requests

Overview

Quick Start

Client

Session

Request Options

Headers and Params

Bodies

Responses

Timeouts

Redirects and Cookies

HTTPS and TLS

Errors

API Reference

WebSocket

Overview

Quick Start

Concepts

Configuration

Server

Session

Router

Messages

Client

Rooms and Broadcasting

Long polling

HTTP API

Attached runtime

Metrics

Message store

SQLite message store

OpenAPI

Shutdown

API Reference

WebRPC

Overview

Quick Start

Requests

Responses

Errors

Context

Router

Dispatcher

Batches and Notifications

Metadata

API Reference

UI

Overview

Views

HTML

HTML Response

Assets

Forms

Live UI

PWA

App Shell

Examples

Tests

Note

Overview

Quick Start

Document Format

Cells

C++ Cells

Reply Cells

HTML Cells

Runtime

Creating Extensions

Extension Manifest

Extension Requirements

Extension Protocol

Pyrelune Tutorial

Project Context

Local UI

Export

API Reference

Cache

Overview

Quick Start

Cache Entry

Cache Policy

Cache Context

Cache Keys

Stores

Memory Store

LRU Memory Store

File Store

Offline and Network Errors

Pruning

Context Mapper

CMake

API Reference

Agent

Overview

Quick Start

Public API

Configuration

Requests and Responses

Workspace

Project Scanning

Model Providers

Ollama

Tools

File Read Tool

Command Tool

Cache and Run History

Custom Providers

Errors

CMake

API Reference

KV

Overview

Opening a database

Keys

Values

Persistence

Recovery

Stats

API Reference

Sync

Overview

Quick Start

Offline-first Model

Operations

Outbox

File Outbox Store

Retry Policy

Transports

Sync Engine

In-flight Recovery

WAL

CMake

API Reference

P2P

Overview

Node

Discovery

Bootstrap

Router

Protocol

WAL Replication

HTTP Control

API Reference

Tooling

CLI

Overview

All Commands

vix build

vix run

vix dev

vix repl

vix note

vix new

vix make

vix modules

vix check

vix tests

vix fmt

vix clean

vix reset

vix replay

vix task

vix search

vix add

vix install

vix update

vix outdated

vix remove

vix list

vix registry

vix store

vix pack

vix verify

vix cache

vix publish

vix unpublish

vix env

vix service

vix proxy

vix deploy

vix health

vix logs

vix ws

vix db

vix orm

vix p2p

vix game

vix agent

vix info

vix doctor

vix upgrade

vix uninstall

vix completion

SDK Profiles

Overview

Default SDK

Web SDK

Data SDK

Desktop SDK

P2P SDK

Game SDK

Agent SDK

Full SDK

Registry

Overview

Package Metadata

vix.json Reference

Publishing Packages

Extensions

Build Cache

Diagnostics

Replay

Examples

Hello App

JSON API

Middleware API

HTTP Cache

Multipart Upload

Cookies

Session Counter

API Key Auth

JWT Auth

RBAC

Static Site

WebSocket Chat

SQLite API

Background Task

Async App

Production Bootstrap

Internals

Architecture

Runtime Model

Direct Compile

Cache System

Error Diagnostics

Performance

Design Decisions

Contributing

Overview

Pull Requests

Code of Conduct

Security

On this page

⌂/Docs/Modules/P2p/Node

Edit this page on GitHub

Last updated:

Pager

Previous pageOverview

Next pageDiscovery

Released under the MIT License.

Vix.cppModern C++ runtime and developer toolkit.

Start Here Understand Vix Build Applications Vix Modules Tooling Reference Internals Contributing Registry GitHub