Skip to content

Commit e5eda3d

Browse files
committed
Document that rejectRequestWith requires closing the stream
I just ran into the same issue described in [jaspervdj#211](jaspervdj#211). In my case I had noticed the note about calling `Stream.close` in the `rejectRequest` docs but I didn't realize that the disclaimer applied to `rejectRequestWith` as well. Based on [this comment](jaspervdj#211 (comment)) maybe it makes sense to close the underlying stream when rejecting the request, but short of that maybe this note will help someone else avoid the same issue.
1 parent ca2e80a commit e5eda3d

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

src/Network/WebSockets/Connection.hs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ defaultRejectRequest = RejectRequest
227227

228228

229229
--------------------------------------------------------------------------------
230+
-- | Requires calling 'pendingStream' and 'Stream.close'.
230231
rejectRequestWith
231232
:: PendingConnection -- ^ Connection to reject
232233
-> RejectRequest -- ^ Params on how to reject the request

0 commit comments

Comments
 (0)