Ouroboros-Network Repository Hackage Documentation

skip to module list

This site contains Haskell documentation of Ouroboros-Network - networking component of the Haskell implementation of Ouroboros protocols.

Documentation

Packages

  • ouroboros-network-api - API shared by ouroboros-network packages and ouroboros-consensus, e.g. common types, APIs that are provided by the consensus layar. Among others, it includes:

    • /Block chain related data structures that the networking code needs to be aware of:/

  • ouroboros-network-framework - our instantiations and implementation of servers, clients, abstractions for working with named pipes and unix sockets. These are higher level components, which don't dependent on ouroboros protocols, but build a solid foundation for the networking library. Among others, it includes
  • Inbound Governor
  • Server P2P
  • Server NonP2P
  • Socket
  • Snocket
  • Simulated Snocket

  • ouroboros-network-protocols - /Implementations, type level specifications, and APIs of all the protocols:/

    Note Handshake mini-protocol is implemented in ourboros-network-framework: * Handshake

  • ouroboros-network - networking library which supports /Ouroboros family of protocols/. It includes:

  • cardano-client - a library which supports subscription mechanism via node-to-client protocol
  • network-mux - an implementation of a network multiplexer.
  • ntp-client - an implementation of an NTP client.
  • cardano-ping - a library which implements a ping over node-to-node and node-to-client protocols. Used by cardano-cli ping command.
  • ouroboros-network-mock - a mock chain, used for testing.
  • ouroboros-network-testing - helpful functions for testing purposes.
  • monoidal-synchronisation - synchronisation primitives (first to finish, last to finish)

Packages

cardano-client-0.4

cardano-ping-0.6.0.0

monoidal-synchronisation-0.1.0.6

ntp-client-0.0.1.6

ouroboros-network-0.18.0.0

ouroboros-network-framework-0.14.0.0

ouroboros-network-framework:testlib-0.14.0.0

ouroboros-network-mock-0.1.1.2

ouroboros-network-protocols-0.12.0.0

ouroboros-network-protocols:testlib-0.12.0.0

quickcheck-monoids-0.1.0.1