on master help sign in
doc update.
commit34a42f7ce6315719d2e87c537acaa5738bff8070 authorKazu Yamamoto <kazu@iij.ad.jp> dateFri 1 Nov 2013, 09:08 (13 years ago) parent6dec773
1 file changed+5−3
warp/Network/Wai/Handler/Warp/Response.hs+5−3
warp/Network/Wai/Handler/Warp/Response.hs+5−3
@@ -86,7 +86,9 @@ checkPartRange fileSize mPart mRange = checkPart mPart mRange
8686--
8787-- The Server header is added if not exist in HTTP response header.
8888--
89−-- ['ResponseFile']
89+-- There are three basic APIs to create 'Response':
90+--
91+-- ['responseFile' :: 'H.Status' -> 'H.ResponseHeaders' -> 'FilePath' -> 'Maybe' 'FilePart' -> 'Response']
9092-- HTTP response body is sent by sendfile().
9193-- Applications are categorized into simple and sophisticated.
9294-- Simple applications should specify 'Nothing' to
@@ -101,12 +103,12 @@ checkPartRange fileSize mPart mRange = checkPart mPart mRange
101103-- they would cause inconsistency.
102104-- Status is also changed to 206 if necessary.
103105--
104−-- ['ResponseSource']
106+-- ['responseBuilder' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Builder' -> 'Response']
105107-- HTTP response body is created from 'Source'.
106108-- Typically, Transfer-Encoding: chunked is used.
107109-- If Content-Length is specified, Transfer-Encoding: chunked is not used.
108110--
109−-- ['ResponseBuilder']
111+-- ['responseSource' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Source' 'IO' ('Flush' 'Builder') -> 'Response']
110112-- HTTP response body is created from 'Builder'.
111113-- Typically, Transfer-Encoding: chunked is used.
112114-- If Content-Length is specified, Transfer-Encoding: chunked is not used.