Keep-Alive

​

Overview

• Connection persistence control
• Resource management
• Performance optimization

​

Installation

import "github.com/go-mizu/mizu/middlewares/keepalive"

​

Quick Start

app := mizu.New()

// Enable keep-alive with defaults
app.Use(keepalive.New())

​

Configuration

​

Options

​

Examples

​

Enable Keep-Alive

app.Use(keepalive.New())

​

Custom Settings

app.Use(keepalive.New(keepalive.Options{
    Timeout:     10 * time.Second,
    MaxRequests: 200,
}))

​

Disable Keep-Alive

app.Use(keepalive.New(keepalive.Options{
    Enabled: false,
}))

​

Per-Route Control

// Disable for long-polling
app.Get("/events", handler, keepalive.Disable())

// Enable for API
app.Get("/api", handler, keepalive.New())

​

API Reference

​

Functions

// New creates keep-alive middleware
func New(opts ...Options) mizu.Middleware

// Disable creates middleware that disables keep-alive
func Disable() mizu.Middleware

​

HTTP Headers

Connection: keep-alive
Keep-Alive: timeout=5, max=100

​

Technical Details

​

Implementation Overview

1. Configuration Initialization: Default values are set during middleware creation (60s timeout, 100 max requests)
2. Request Processing: For each incoming request, the middleware:
   • Checks if keep-alive is disabled via DisableKeepAlive option
   • Inspects the client’s Connection header to detect if the client requested connection closure
   • Sets appropriate response headers based on configuration and client preferences
3. Header Management: The middleware sets:
   • Connection: keep-alive to indicate persistent connection support
   • Keep-Alive: timeout={seconds}, max={requests} to specify connection parameters

​

Key Components

• Options struct: Configures timeout duration, maximum requests per connection, and enable/disable flag
• Default values: 60 seconds timeout, 100 maximum requests when not specified
• Client negotiation: Respects client’s Connection: close header to gracefully close connections
• Helper functions: Provides Disable(), WithTimeout(), and WithMax() for common configurations

​

Header Format

• timeout: Duration in seconds that the connection should remain open
• max: Maximum number of requests allowed on this connection

​

Best Practices

• Use for high-traffic APIs
• Set reasonable timeouts
• Monitor connection counts
• Consider disabling for long-polling

​

Testing

​

Related Middlewares

• timeout - Request timeout
• maxconns - Connection limits