new HttpServerResponse()
Represents a server-side HTTP response.
An instance of this is created and associated to every instance of
- Source:
Methods
bodyEndHandler(handler) → {HttpServerResponse}
Provide a handler that will be called just before the last part of the body is written to the wire
and the response is ended.
This provides a hook allowing you to do any more operations before this occurs.
Parameters:
Name |
Type |
Description |
handler |
function
|
the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
bytesWritten() → {number}
- Source:
Returns:
close()
Close the underlying TCP connection corresponding to the request.
- Source:
closed() → {boolean}
- Source:
Returns:
closeHandler(handler) → {HttpServerResponse}
Set a close handler for the response. This will be called if the underlying connection closes before the response
is complete.
Parameters:
Name |
Type |
Description |
handler |
function
|
the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
drainHandler(handler) → {HttpServerResponse}
Parameters:
Name |
Type |
Description |
handler |
function
|
|
- Source:
Returns:
-
Type
-
HttpServerResponse
end(chunk, enc)
Same as HttpServerResponse#end but writes a String with the specified encoding before ending the response.
Parameters:
Name |
Type |
Description |
chunk |
string
|
the string to write before ending the response |
enc |
string
|
the encoding to use |
- Source:
ended() → {boolean}
- Source:
Returns:
exceptionHandler(handler) → {HttpServerResponse}
Parameters:
Name |
Type |
Description |
handler |
function
|
|
- Source:
Returns:
-
Type
-
HttpServerResponse
getStatusCode() → {number}
- Source:
Returns:
getStatusMessage() → {string}
- Source:
Returns:
- Source:
Returns:
-
The HTTP headers
-
-
Type
-
MultiMap
headersEndHandler(handler) → {HttpServerResponse}
Provide a handler that will be called just before the headers are written to the wire.
This provides a hook allowing you to add any more headers or do any more operations before this occurs.
Parameters:
Name |
Type |
Description |
handler |
function
|
the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
headWritten() → {boolean}
- Source:
Returns:
isChunked() → {boolean}
- Source:
Returns:
-
is the response chunked?
-
-
Type
-
boolean
push(method, host, path, headers, handler) → {HttpServerResponse}
Push a response to the client.
The
handler
will be notified with a
success when the push can be sent and with
a
failure when the client has disabled push or reset the push before it has been sent.
The
handler
may be queued if the client has reduced the maximum number of streams the server can push
concurrently.
Push can be sent only for peer initiated streams and if the response is not ended.
Parameters:
Name |
Type |
Description |
method |
Object
|
the method of the promised request |
host |
string
|
the host of the promised request |
path |
string
|
the path of the promised request |
headers |
MultiMap
|
the headers of the promised request |
handler |
function
|
the handler notified when the response can be written |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
Put an HTTP header
Parameters:
Name |
Type |
Description |
name |
string
|
the header name |
value |
string
|
the header value. |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
putTrailer(name, value) → {HttpServerResponse}
Put an HTTP trailer
Parameters:
Name |
Type |
Description |
name |
string
|
the trailer name |
value |
string
|
the trailer value |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
reset(code)
Reset this HTTP/2 stream with the error code
.
Parameters:
Name |
Type |
Description |
code |
number
|
the error code |
- Source:
sendFile(filename, offset, length, resultHandler) → {HttpServerResponse}
Like HttpServerResponse#sendFile but providing a handler which will be notified once the file has been
completely written to the wire.
Parameters:
Name |
Type |
Description |
filename |
string
|
path to the file to serve |
offset |
number
|
the offset to serve from |
length |
number
|
the length to serve to |
resultHandler |
function
|
handler that will be called on completion |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
setChunked(chunked) → {HttpServerResponse}
If
chunked
is
true
, this response will use HTTP chunked encoding, and each call to write to the body
will correspond to a new HTTP chunk sent on the wire.
If chunked encoding is used the HTTP header Transfer-Encoding
with a value of Chunked
will be
automatically inserted in the response.
If chunked
is false
, this response will not use HTTP chunked encoding, and therefore the total size
of any data that is written in the respone body must be set in the Content-Length
header before any
data is written out.
An HTTP chunked response is typically used when you do not know the total size of the request body up front.
Parameters:
Name |
Type |
Description |
chunked |
boolean
|
|
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
setStatusCode(statusCode) → {HttpServerResponse}
Set the status code. If the status message hasn't been explicitly set, a default status message corresponding
to the code will be looked-up and used.
Parameters:
Name |
Type |
Description |
statusCode |
number
|
|
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
setStatusMessage(statusMessage) → {HttpServerResponse}
Set the status message
Parameters:
Name |
Type |
Description |
statusMessage |
string
|
|
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
setWriteQueueMaxSize(maxSize) → {HttpServerResponse}
Parameters:
Name |
Type |
Description |
maxSize |
number
|
|
- Source:
Returns:
-
Type
-
HttpServerResponse
streamId() → {number}
- Source:
Returns:
trailers() → {MultiMap}
- Source:
Returns:
-
The HTTP trailers
-
-
Type
-
MultiMap
write(chunk, enc) → {HttpServerResponse}
Write a String to the response body, encoded using the encoding enc
.
Parameters:
Name |
Type |
Description |
chunk |
string
|
the string to write |
enc |
string
|
the encoding to use |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
writeContinue() → {HttpServerResponse}
Used to write an interim 100 Continue response to signify that the client should send the rest of the request.
Must only be used if the request contains an "Expect:100-Continue" header
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
writeCustomFrame(type, flags, payload) → {HttpServerResponse}
Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.
The frame is sent immediatly and is not subject to flow control.
Parameters:
Name |
Type |
Description |
type |
number
|
the 8-bit frame type |
flags |
number
|
the 8-bit frame flags |
payload |
Buffer
|
the frame payload |
- Source:
Returns:
a reference to this, so the API can be used fluently
-
Type
-
HttpServerResponse
writeQueueFull() → {boolean}
This will return true
if there are more bytes in the write queue than the value set using HttpServerResponse#setWriteQueueMaxSize
- Source:
Returns:
true if write queue is full
-
Type
-
boolean