Squid Programmers Guide

Squid Developers

1. Introduction

• 1.1 Conventions

2. Coding Conventions

• 2.1 Infrastructure

3. Overview of Squid Components

• 3.1 Client Side Socket
• 3.2 Client Side Request
• 3.3 Client Side Reply
• 3.4 Client Streams
• 3.5 Server Side
• 3.6 Storage Manager
• 3.7 Request Forwarding
• 3.8 Peer Selection
• 3.9 Access Control
• 3.10 Authentication Framework
• 3.11 Network Communication
• 3.12 File/Disk I/O
• 3.13 Neighbors
• 3.14 IP/FQDN Cache
• 3.15 Cache Manager
• 3.16 Network Measurement Database
• 3.17 Redirectors
• 3.18 Autonomous System Numbers
• 3.19 Configuration File Parsing
• 3.20 Callback Data Allocator
• 3.21 Refcount Data Allocator (C++ Only)
• 3.22 Debugging
• 3.23 Error Generation
• 3.24 Event Queue
• 3.25 Filedescriptor Management
• 3.26 Hashtable Support
• 3.27 HTTP Anonymization
• 3.28 Delay Pools
• 3.29 Internet Cache Protocol
• 3.30 Ident Lookups
• 3.31 Memory Management
• 3.32 Multicast Support
• 3.33 Persistent Server Connections
• 3.34 Refresh Rules
• 3.35 SNMP Support
• 3.36 URN Support
• 3.37 ESI

4. External Programs

• 4.1 dnsserver
• 4.2 pinger
• 4.3 unlinkd
• 4.4 redirector

5. Flow of a Typical Request

6. Callback Functions

7. The Main Loop: comm_select()

8. Client Streams

• 8.1 Introduction
• 8.2 Implementation notes
• 8.3 Whats in a node
• 8.4 Method details

9. Processing Client Requests

10. Delay Pools

• 10.1 Introduction
• 10.2 Extending Delay Pools
• 10.3 Neat things that could be done.

11. Storage Manager

• 11.1 Introduction
• 11.2 Object storage
• 11.3 Object retrieval

12. Storage Interface

• 12.1 Introduction
• 12.2 Build structure
• 12.3 Initialization of a storage type
• 12.4 Operation of a storage module
• 12.5 Store IO calls
• 12.6 Callbacks
• 12.7 State Logging
• 12.8 Replacement policy implementation
• 12.9 Removal policy API

13. Forwarding Selection

14. IP Cache and FQDN Cache

• 14.1 Introduction
• 14.2 Data Structures
• 14.3 External overview
• 14.4 Internal Operation

15. Server Protocols

• 15.1 HTTP
• 15.2 FTP
• 15.3 Gopher
• 15.4 Wais
• 15.5 SSL
• 15.6 Passthrough

16. Timeouts

17. Events

18. Access Controls

19. Authentication Framework

• 19.1 Authentication Scheme API
• 19.2 Authentication Module Interface

20. ICP

21. Network Measurement Database

22. Error Pages

23. Callback Data Allocator

• 23.1 API
• 23.2 Examples

24. Refcount Data Allocator (C++ Only)

• 24.1 API

25. Cache Manager

26. HTTP Headers

• 26.1 General remarks
• 26.2 Life cycle
• 26.3 Header Manipulation
• 26.4 I/O and Headers
• 26.5 Adding new header-field ids
• 26.6 A Word on Efficiency

27. File Formats

• 27.1 swap.state

28. Store ``swap meta'' Description

• 28.1 Types
• 28.2 Implementation Notes

29. leakFinder

30. MemPools

• 30.1 Public API