Documentation

Documentation Overview

This wiki documents the ArgusTransfer framework -- a lightweight library for building REST-like APIs over named pipes using the ARGUS/1.0 wire protocol.

Getting Started

• Quick Start -- set up a server, module, and client in minutes

Core Concepts

• Architecture and Protocol -- the ARGUS/1.0 wire format, verbs, status codes, headers, and message model
• Routing and Modules -- define endpoints with route templates, parameters, and constraints using IArgusModule
• Middleware -- build global and per-endpoint middleware for logging, authorization, and more
• Serialization -- body serializers, the serializer registry, and chunked transfer encoding

Usage Guides

• Client Usage -- send requests with IArgusClient, including query parameters, streaming bodies, and timeouts
• Server Configuration -- configure the pipe host with concurrency limits, request timeouts, and graceful shutdown
• Dependency Injection -- extension methods, service lifetimes, and DI integration

Project

• Development Environment -- IDE setup, SDK requirements, build commands, and code conventions
• Developers Experience -- contributing guidelines, ticketing, and code review
• Roadmap -- planned features and project direction