API Reference

API Reference

Every public header, the wiki page that documents it, and its prefix. Include the canonical path shown here (see Linking). The generated Doxygen reference is at https://c4punks.github.io/CWIST/, and API Quick Reference is a flat list of common calls.

Application

Header	Page	Prefix
cwist/app.h -> cwist/sys/app/app.h	Application, Routing, Multiport, Streaming Responses	cwist_app_, cwist_multiport_, cwist_stream_req_
cwist/sys/app/middleware.h	Middleware	cwist_mw_
cwist/sys/app/endpoint_opts.h	Routing	CWIST_ENDPOINT_
cwist/sys/app/config.h	Configuration and Environment	cwist_config_
cwist/sys/app/logger.h, cwist/core/log.h	Logging	cwist_logger_, CWIST_LOG_
cwist/sys/app/shutdown.h	Graceful Shutdown	cwist_shutdown_
cwist/sys/app/test_client.h	Testing	cwist_test_client_
cwist/sys/app/assets.h	Static Files and Assets	cwist_app_asset_
cwist/sys/app/big_dumb_reply.h	Big Dumb Reply Cache	cwist_bdr_
cwist/sys/app/compress.h	Compression	cwist_compress_
cwist/sys/app/csrf.h, cwist/sys/app/waf.h	CSRF and WAF	cwist_csrf_, cwist_waf_
cwist/openapi.h	OpenAPI	CWIST_OPENAPI_
cwist/sys/err/cwist_err.h	Error Handling	cwist_error_
cwist/core/macros.h	Error Handling	CWIST_KIB, CWIST_MIB, CWIST_UNUSED

HTTP and protocols

Header	Page	Prefix
cwist/net/http/http.h	Requests and Responses	cwist_http_
cwist/net/http/async.h	Async Handlers	cwist_async_
cwist/net/http/https.h	HTTPS and TLS	cwist_https_
cwist/security/tls/ech.h	HTTPS and TLS	cwist_app_use_ech
cwist/net/http/http2.h, http2_flow_control.h	HTTP/2	cwist_http2_, h2_
cwist/net/http/http3.h	HTTP/3 and QUIC, WebTransport	cwist_http3_, cwist_webtransport_
cwist/net/http/http3_client.h	HTTP/3 and QUIC, WebTransport	cwist_http3_client_, cwist_webtransport_client_
cwist/net/http/http_client.h	HTTP Clients	cwist_http_client_
cwist/net/websocket/websocket.h, websocket_async.h	WebSocket	cwist_websocket_, cwist_ws_
cwist/net/http/sse.h (cwist/sse.h)	Server-Sent Events	cwist_sse_
cwist/net/http/cookie.h	Cookies	cwist_cookie_
cwist/net/http/session.h, cwist/sys/session/flash.h, session_manager.h	Sessions and Flash	cwist_session_, cwist_flash_, session_
cwist/net/http/query.h	Query Maps	cwist_query_map_
cwist/net/http/multipart.h	Multipart Uploads	cwist_multipart_
cwist/net/http/mux.h	Routing	cwist_mux_
cwist/net/http/html_response.h	HTML Components	cwist_http_response_set_view and friends
cwist/net/grpc/grpc.h	gRPC Server	cwist_grpc_, cwist_app_grpc_
cwist/net/grpc/grpc_client.h, grpc_channel.h	gRPC Client	cwist_grpc_client_, cwist_grpc_call_, cwist_grpc_channel_
cwist/net/grpc/protobuf.h	Protobuf and Codegen	cwist_pb_
cwist/net/graphql/graphql.h, graphql_ws.h	GraphQL	cwist_graphql_
cwist/net/webrtc.h	WebRTC DataChannels	cwist_webrtc_

Data

Header	Page	Prefix
cwist/core/db/sql.h, pool.h, migrate.h, nuke_db.h	Database	cwist_db_, cwist_db_pool_, cwist_migrate_, cwist_nuke_
cwist/security/db_crypt/db_crypt.h, cwist/net/db_sync/db_sync.h	Database	cwist_db_crypt_, cwist_db_sync_
cwist/core/orm/orm.h, orm_socket.h	ORM	cwist_orm_
cwist/net/redis/cwist_redis.h (cwist/redis.h)	Redis	cwist_redis_
cwist/net/nats/cwist_nats.h	NATS	cwist_nats_
cwist/sys/job/durable_queue.h	Durable Job Queue	cwist_job_
cwist/sys/job/scheduler.h, cwist/sys/io/cwist_io.h	Scheduler	cwist_scheduler_, cwist_io_queue_

Content

Header	Page	Prefix
cwist/core/html/builder.h, component.h, css_composer.h	HTML Components	cwist_html_, cwist_css_
cwist/core/template/template.h	Templates	cwist_template_
cwist/core/utils/json_builder.h, json_heal.h	JSON	cwist_json_, cwist_heal_
cwist/core/utils/zod.h, cwist/core/validation/bind.h	Validation	cwist_zod_, cwist_bind_, CWIST_BIND_, CWIST_RULE_
cwist/security/jwt/jwt.h	JWT	cwist_jwt_
cwist/core/seq/seq.h, seq_auth.h	Sequenced Messages	cwist_seq_, cwist_seq_auth_

Runtime

Header	Page	Prefix
cwist/core/mem/alloc.h, arena.h	Memory Management	cwist_alloc, cwist_free, cwist_arena_, CWIST_DEFER_FREE
cwist/core/mem/gc.h, intercept.h	Full GC, Async GC Ownership	cwist_full_gc, cwist_gc_
cwist/core/sstring/sstring.h	SString	cwist_sstring_
cwist/core/siphash/siphash.h, cwist/core/crypto/sha256.h	Query Maps, Sessions and Flash	siphash24, cwist_sha256_
cwist/sys/io/reactor.h, cwist/sys/sys_info.h	Reactor and I/O	cwist_reactor_, cwist_get_available_ram
cwist/sys/metrics/metrics.h, cwist/sys/health/healthz.h	Metrics and Health	cwist_metric_, cwist_metrics_, cwist_healthz_
cwist/sys/wasi.h, cwist/wasm/*.h	WASI, WASM Browser Builds, WASM Component Model	CWIST_WASI_, cwist_wasm_