http

超文本传输协议模块,用以支持 http 协议处理

Field Summary

Type Method and Description
readonly List public static readonly List cookiescookiescookies

返回http客户端的 HttpCookie 对象列表

Integer public static Integer timeouttimeouttimeout

查询和设置超时时间

Boolean public static Boolean enableCookieenableCookieenableCookie

cookie功能开关,默认开启

Boolean public static Boolean autoRedirectautoRedirectautoRedirect

自动redirect功能开关,默认开启

String public static String userAgentuserAgentuserAgent

查询和设置 http 请求中的浏览器标识

Method Summary

Type Method and Description
HttpRequest new Request()

创建一个 http 请求对象,参见 HttpRequest

HttpResponse new Response()

创建一个 http 响应对象,参见 HttpResponse

HttpCookie new Cookie()

创建一个 http cookie 对象,参见 HttpCookie

HttpServer new Server()

创建一个 http 服务器,参见 HttpServer

HttpClient new Client()

创建一个 http 客户端,参见 HttpClient

HttpsServer new HttpsServer()

创建一个 https 服务器,参见 HttpsServer

HttpHandler new Handler()

创建一个 http 协议处理器对象,参见 HttpHandler

Handler fileHandler(String root,Object mimes)

创建一个 http 静态文件处理器,用以用静态文件响应 http 消息

HttpResponse request(Stream conn,HttpRequest req)

发送 http 请求到指定的流对象,并返回结果

HttpResponse request(String method,String url,Object headers)

请求指定的 url,并返回结果

HttpResponse request(String method,String url,SeekableStream body,Map headers)

请求指定的 url,并返回结果

HttpResponse request(String method,String url,SeekableStream body,Object headers)

请求指定的 url,并返回结果

HttpResponse request(String method,String url,Buffer body,Object headers)

请求指定的 url,并返回结果

HttpResponse get(String url,Object headers)

用 GET 方法请求指定的 url,并返回结果,等同于 request(“GET”, …)

HttpResponse post(String url,SeekableStream body,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

HttpResponse post(String url,Buffer body,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

HttpResponse post(String url,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

HttpResponse del(String url,Object headers)

用 DELETE 方法请求指定的 url,并返回结果,等同于 request(“DELETE”, …)

HttpResponse put(String url,SeekableStream body,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

HttpResponse put(String url,Buffer body,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

HttpResponse put(String url,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

HttpResponse patch(String url,SeekableStream body,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

HttpResponse patch(String url,Buffer body,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

HttpResponse patch(String url,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

Field Detail

cookies

readonly List public static readonly List cookiescookiescookies

返回http客户端的 HttpCookie 对象列表

timeout

Integer public static Integer timeouttimeouttimeout

查询和设置超时时间

enableCookie

Boolean public static Boolean enableCookieenableCookieenableCookie

cookie功能开关,默认开启

autoRedirect

Boolean public static Boolean autoRedirectautoRedirectautoRedirect

自动redirect功能开关,默认开启

userAgent

String public static String userAgentuserAgentuserAgent

查询和设置 http 请求中的浏览器标识

Method Detail

Request

HttpRequest new Request()

创建一个 http 请求对象,参见 HttpRequest

Response

HttpResponse new Response()

创建一个 http 响应对象,参见 HttpResponse

Cookie

创建一个 http cookie 对象,参见 HttpCookie

Server

HttpServer new Server()

创建一个 http 服务器,参见 HttpServer

Client

HttpClient new Client()

创建一个 http 客户端,参见 HttpClient

HttpsServer

HttpsServer new HttpsServer()

创建一个 https 服务器,参见 HttpsServer

Handler

HttpHandler new Handler()

创建一个 http 协议处理器对象,参见 HttpHandler

fileHandler

Handler fileHandler(String root,Object mimes)

创建一个 http 静态文件处理器,用以用静态文件响应 http 消息

Parameters

  • root 文件根路径

  • mimes 扩展 mime 设置

Returns

返回一个静态文件处理器用于处理 http 消息

fileHandler 支持 gzip 预压缩,当请求接受 gzip 编码,且相同路径下 filename.ext.gz 文件存在时,将直接返回此文件, 从而避免重复压缩带来服务器负载。

request

HttpResponse request(Stream conn,HttpRequest req)

发送 http 请求到指定的流对象,并返回结果

Parameters

  • conn 指定处理请求的流对象

  • req 要发送的 HttpRequest 对象

Returns

返回服务器响应

request

HttpResponse request(String method,String url,Object headers)

请求指定的 url,并返回结果

Parameters

  • method 指定 http 请求方法:GET, POST 等

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

request

HttpResponse request(String method,String url,SeekableStream body,Map headers)

请求指定的 url,并返回结果

Parameters

  • method 指定 http 请求方法:GET, POST 等

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头

Returns

返回服务器响应

request

HttpResponse request(String method,String url,SeekableStream body,Object headers)

请求指定的 url,并返回结果

Parameters

  • method 指定 http 请求方法:GET, POST 等

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

request

HttpResponse request(String method,String url,Buffer body,Object headers)

请求指定的 url,并返回结果

Parameters

  • method 指定 http 请求方法:GET, POST 等

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

get

HttpResponse get(String url,Object headers)

用 GET 方法请求指定的 url,并返回结果,等同于 request(“GET”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

post

HttpResponse post(String url,SeekableStream body,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

post

HttpResponse post(String url,Buffer body,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

post

HttpResponse post(String url,Object headers)

用 POST 方法请求指定的 url,并返回结果,等同于 request(“POST”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

del

HttpResponse del(String url,Object headers)

用 DELETE 方法请求指定的 url,并返回结果,等同于 request(“DELETE”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

put

HttpResponse put(String url,SeekableStream body,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

put

HttpResponse put(String url,Buffer body,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

put

HttpResponse put(String url,Object headers)

用 PUT 方法请求指定的 url,并返回结果,等同于 request(“PUT”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

patch

HttpResponse patch(String url,SeekableStream body,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

patch

HttpResponse patch(String url,Buffer body,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • body 指定发送的 body 内容

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应

patch

HttpResponse patch(String url,Object headers)

用 PATCH 方法请求指定的 url,并返回结果,等同于 request(“PATCH”, …)

Parameters

  • url 指定 url,必须是包含主机的完整 url

  • headers 指定附加的 http 头,缺省无附加头

Returns

返回服务器响应