Squid Programmers Guide

Squid Developers

1. Introduction

• 1.1 Conventions

2. Overview of Squid Components

• 2.1 Client Side
• 2.2 Server Side
• 2.3 Storage Manager
• 2.4 Request Forwarding
• 2.5 Peer Selection
• 2.6 Access Control
• 2.7 Authentication Framework
• 2.8 Network Communication
• 2.9 File/Disk I/O
• 2.10 Neighbors
• 2.11 IP/FQDN Cache
• 2.12 Cache Manager
• 2.13 Network Measurement Database
• 2.14 Redirectors
• 2.15 Autonomous System Numbers
• 2.16 Configuration File Parsing
• 2.17 Callback Data Allocator
• 2.18 Debugging
• 2.19 Error Generation
• 2.20 Event Queue
• 2.21 Filedescriptor Management
• 2.22 Hashtable Support
• 2.23 HTTP Anonymization
• 2.24 Internet Cache Protocol
• 2.25 Ident Lookups
• 2.26 Memory Management
• 2.27 Multicast Support
• 2.28 Persistent Server Connections
• 2.29 Refresh Rules
• 2.30 SNMP Support
• 2.31 URN Support

3. External Programs

• 3.1 dnsserver
• 3.2 pinger
• 3.3 unlinkd
• 3.4 redirector

4. Flow of a Typical Request

5. Callback Functions

6. The Main Loop: comm_select()

7. Processing Client Requests

8. Storage Manager

• 8.1 Introduction
• 8.2 Object storage
• 8.3 Object retrieval

9. Storage Interface

• 9.1 Introduction
• 9.2 Build structure
• 9.3 Initialization of a storage type
• 9.4 Operation of a storage module
• 9.5 Store IO calls
• 9.6 Callbacks
• 9.7 State Logging
• 9.8 Replacement policy implementation
• 9.9 Removal policy API

10. Forwarding Selection

11. IP Cache and FQDN Cache

• 11.1 Introduction
• 11.2 Data Structures
• 11.3 External overview
• 11.4 Internal Operation

12. Server Protocols

• 12.1 HTTP
• 12.2 FTP
• 12.3 Gopher
• 12.4 Wais
• 12.5 SSL
• 12.6 Passthrough

13. Timeouts

14. Events

15. Access Controls

16. Authentication Framework

• 16.1 Authentication Scheme API
• 16.2 Authentication Module Interface

17. ICP

18. Network Measurement Database

19. Error Pages

20. Callback Data Allocator

• 20.1 API
• 20.2 Examples

21. Cache Manager

22. HTTP Headers

• 22.1 General remarks
• 22.2 Life cycle
• 22.3 Header Manipulation
• 22.4 I/O and Headers
• 22.5 Adding new header-field ids
• 22.6 A Word on Efficiency

23. File Formats

• 23.1 swap.state

24. Store ``swap meta'' Description

• 24.1 Types
• 24.2 Implementation Notes

25. leakFinder

26. MemPools

• 26.1 Public API