Skip to content

Commit dbed6ac

Browse files
committed
framework: added haddocks to the simple server
1 parent e989050 commit dbed6ac

File tree

1 file changed

+9
-0
lines changed
  • ouroboros-network/framework/lib/Ouroboros/Network/Server

1 file changed

+9
-0
lines changed

ouroboros-network/framework/lib/Ouroboros/Network/Server/Simple.hs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,23 @@ with :: forall fd addr vNumber vData m a b.
5656
Show vNumber
5757
)
5858
=> Snocket m fd addr
59+
-- ^ low level snocket API
5960
-> Tracer m (ServerTracer addr)
61+
-- ^ server tracer: must not be `nullTracer` in production
6062
-> Mx.TracersWithBearer (ConnectionId addr) m
63+
-- ^ mux tracers
6164
-> Mx.MakeBearer m fd
6265
-> (fd -> addr -> m ())
66+
-- ^ socket configuration for both listening and connection sockets
6367
-> addr
68+
-- ^ server address to bind to
6469
-> HandshakeArguments (ConnectionId addr) vNumber vData m
70+
-- ^ handshake arguments
6571
-> Versions vNumber vData (SomeResponderApplication addr BL.ByteString m b)
72+
-- ^ applications to run on each connection
6673
-> (addr -> Async m Void -> m a)
74+
-- ^ continuation for an internally used `withAsync` function that runs
75+
-- server accept loop
6776
-> m a
6877
with sn tracer muxTracers makeBearer configureSock addr handshakeArgs versions k =
6978
JobPool.withJobPool $ \jobPool ->

0 commit comments

Comments
 (0)