git.iko.soy/distributed-process
on master help sign in
Improve docs
49a36ceEdsko de Vries
network-transport/src/Network/Transport.hs+5
@@ -60,6 +60,11 @@ data EndPoint = EndPoint {
60-- | Lightweight connection to an endpoint.
60-- | Lightweight connection to an endpoint.
61data Connection = Connection {
61data Connection = Connection {
62 -- | Send a message on this connection.
62 -- | Send a message on this connection.
63+ --
64+ -- 'send' provides vectored I/O, and allows multiple data segments to be
65+ -- sent using a single call (cf. 'Network.Socket.ByteString.sendMany').
66+ -- Note that this segment structure is entirely unrelated to the segment
67+ -- structure /returned/ by a 'Received' event.
63 send :: [ByteString] -> IO (Either (TransportError SendErrorCode) ())
68 send :: [ByteString] -> IO (Either (TransportError SendErrorCode) ())
64 -- | Close the connection.
69 -- | Close the connection.
65 , close :: IO ()
70 , close :: IO ()