This module contains a defination of the header of a HTTP message.

Overview

A HTTP message consists of a header and a body. The header defines the operating parameters of an HTTP transaction, and the body is the data bytes transmitted in an HTTP transaction message immediately following the header. The header consists of a start line and zero or more header fields.

A message sent by a client is called a request, and a message sent by a server is called a response.

The start line of a request is called request line, which consists of a request method, a url and a version. The start line of a response is called status line, which consists of a status code, a reason and a version.

See Hypertext Transfer Protocol for more information.

Usage

Request

To output a request message:

import netkit/http/version
import netkit/http/httpmethod
import netkit/http/headerfields
import netkit/http/header

var header = HttpHeader(
  kind: HttpHeaderKind.Request,
  reqMethod: HttpGet,
  url: "/",
  version: HttpVersion11,
  fields: initHeaderFields: {
    "Host": "www.iocrate.com"
  }
)
assert toResponseStr(Http200) = "GET / HTTP/1.1\r\nHost: www.iocrate.com\r\n\r\n"

Response

To output a response message:

import netkit/http/version
import netkit/http/status
import netkit/http/headerfields
import netkit/http/header

var header = HttpHeader(
  kind: HttpHeaderKind.Response,
  statusCode: Http200,
  version: HttpVersion11,
  fields: initHeaderFields: {
    "Host": "www.iocrate.com"
  }
)
assert toResponseStr(Http200) = "200 OK HTTP/1.1\r\nHost: www.iocrate.com\r\n\r\n"

To output a response message without fields:

import netkit/http/status
import netkit/http/header

assert toResponseStr(Http200) = "200 OK HTTP/1.1\r\n\r\n"

Imports

spec, httpmethod, version, status, headerfield

Types

HttpHeaderKind{...}{.pure.} = enum Request, Response: Kind of HTTP message. Source Edit
HttpHeader = object case kind*: HttpHeaderKind of HttpHeaderKind.Request: reqMethod*: HttpMethod url*: string of HttpHeaderKind.Response: statusCode*: HttpCode version*: HttpVersion fields*: HeaderFields: Represents the header of a HTTP message. Each message must contain only one header. Source Edit

Procs

proc toResponseStr(H: HttpHeader): string {...}{.raises: [], tags: [].}

Returns a header of a response message.

Examples:

import netkit/http/version
import netkit/http/status
import netkit/http/headerfields
import netkit/http/header

var header = HttpHeader(
  kind: HttpHeaderKind.Response,
  statusCode: Http200,
  version: HttpVersion11,
  fields: initHeaderFields: {
    "Host": "www.iocrate.com"
  }
)
assert toResponseStr(Http200) = "200 OK HTTP/1.1\r\nHost: www.iocrate.com\r\n\r\n"

Source Edit

proc toResponseStr(code: HttpCode): string {...}{.raises: [], tags: [].}

Returns a header of a response message, code specifies the status code. The header fields is empty.

Examples:

import netkit/http/status
import netkit/http/header

assert toResponseStr(Http200) = "200 OK HTTP/1.1\r\n\r\n"

Source Edit

proc toRequestStr(H: HttpHeader): string {...}{.raises: [], tags: [].}

Returns a header of a request message.

Examples:

import netkit/http/version
import netkit/http/httpmethod
import netkit/http/headerfields
import netkit/http/header

var header = HttpHeader(
  kind: HttpHeaderKind.Request,
  reqMethod: HttpGet,
  url: "/",
  version: HttpVersion11,
  fields: initHeaderFields: {
    "Host": "www.iocrate.com"
  }
)
assert toResponseStr(Http200) = "GET / HTTP/1.1\r\nHost: www.iocrate.com\r\n\r\n"

Source Edit