Module holochain::prelude::dependencies::kitsune_p2p_types::dht::prelude

source ·
Expand description

Common exports

Structs§

  • AgentKey
    The hash of an Agent
  • Arq
    A quantized DHT arc.
  • ArqSet
    A collection of ArqBounds. All bounds are guaranteed to be quantized to the same power (the lowest common power).
  • ArqStrat
    “Arq Resizing Strategy”. Defines all parameters necessary to run the arq resizing algorithm.
  • Dimension
    Defines the quantization of a dimension of spacetime.
  • GossipParams
    Node-specific parameters for gossip. While the Topology must be the same for every node in a network, each node is free to choose its own GossipParams.
  • Loc
    Type for representing a location that can wrap around a u32 dht arc
  • LocalStorageConfig
    Configure settings for arc storage.
  • OpHash
    The hash of an Op
  • PeerViewQ
    The Quantized PeerView
  • PowerStats
    Statistics about the power levels of all arqs in a view. Used to make inferences about what your neighbors are up to.
  • Region
    The coordinates defining the Region, along with the calculated RegionData
  • RegionBounds
    A region specified in absolute coords, rather than quantum coords. This type should only be used in the host, which deals in absolute coords. Kitsune itself should only use RegionCoords to ensure proper quantum alignment.
  • RegionCoordSetLtcs
    A compact representation of a set of RegionCoords. The TelescopingTimes generates all relevant TimeSegments, and the SpaceSegments are implied by the [ArqBoundsSet].
  • RegionCoords
    The cross product of a space segment and at time segment forms a Region. Hence, these two segments are the coordinates which define a Region of spacetime.
  • RegionData
    The pertinent data that we care about for each Region. This is what gets sent over gossip so that nodes can discover which Regions are different between them.
  • RegionDataCompact
    Tuple-based representation of RegionData, used for sending more compact wire messages
  • RegionHash
    The hash of a Region, which is the XOR of all OpHashes contained in this region.
  • RegionSetLtcs
    Implementation for the compact LTCS region set format which gets sent over the wire. The coordinates for the regions are specified by a few values. The data to match the coordinates are specified in a 2D vector which must correspond to the generated coordinates.
  • Segment
    Any interval in space or time is represented by a node in a tree, so our way of describing intervals uses tree coordinates as well: The length of an interval is 2^(power), and the position of its left edge is at (offset * length).
  • SpaceOffset
    An Offset in space.
  • SpaceQuantum
    Represents some particular quantum area of space. The actual DhtLocation that this coordinate corresponds to depends upon the space quantum size specified in the Topology
  • SpacetimeQuantumCoords
    A SpaceQuantum and a TimeQuantum form a quantum of spacetime
  • TelescopingTimes
    A type which generates a sequence of exponentially expanding TimeSegments, with the smallest possible segment covering the most recent time, and larger segments as we go further back in time.
  • TimeOffset
    An Offset in time.
  • TimeQuantum
    Represents some particular quantum area of time . The actual Timestamp that this coordinate corresponds to depends upon the time quantum size specified in the Topology
  • Timestamp
    A microsecond-precision UTC timestamp for use in Holochain’s actions.
  • Topology
    Topology defines the structure of spacetime, in particular how space and time are quantized.
  • UpdateArqStats
    A summary of what happened while updating an Arq

Enums§

  • ArqClamping
    Instructions to clamp all arqs to a certain size, regardless of network conditions. This allows the user to either be the ultimate freeloader, or the ultimate benefactor.
  • GossipError
  • PeerStrat
    A Strategy for generating PeerViews. The enum allows us to add new strategies over time.
  • PeerView
    A “view” of the peers in a neighborhood. The view consists of a few observations about the distribution of peers within a particular arc, used to make inferences about the rest of the (out-of-view) DHT, ultimately enabling the calculation of the target arc size for the agent who has this View.
  • RegionSet
    The generic definition of a set of Regions. The current representation is very specific to our current algorithm, but this is an enum to make room for a more generic representation, e.g. a simple Vec<Region>, if we want a more intricate algorithm later.

Constants§

  • REGION_MASS
    The constant size in bytes of a region, used for calculating bandwidth usage during gossip. All regions require the same number of bytes.
  • STANDARD_QUANTUM_TIME
    Quantum time used in the standard topology

Traits§

  • AccessOpStore
    All methods involved in accessing the op store, to be implemented by the host.
  • AccessPeerStore
    All methods involved in accessing the peer store, to be implemented by the host.
  • ArqStart
    Represents the start point or “left edge” of an Arq.
  • HostAccess
    Represents all methods implemented by the host.
  • HostAccessTest
    Represents all methods implemented by the host.
  • Offset
    An Offset represents the position of the left edge of some Segment. Offsets must be paired with a power to map to quantum coordinates. The absolute DhtLocation of the offset is determined by the “power” of its context, and topology of the space, by:
  • OpRegion
    Everything that Kitsune needs to know about an Op. Intended to be implemented by the host.
  • Quantum
    A quantum in the physical sense: the smallest possible amount of something. Here, we are talking about Time and Space quanta.
  • RegionDataConstraints
    The constraints necessary for any RegionData

Functions§

  • actual_coverage
    The actual coverage provided by these peers. Assumes that this is the entire view of the DHT, all peers are accounted for here.
  • approximate_arq
    Given a center and a length, give Arq which matches most closely given the provided strategy
  • array_xor
    Take bitwise XOR of each element of both arrays
  • fake_hash
    Get a fake hash, for testing only.
  • hash_slice_32
    Get the 32 byte slice of a larger slice representing hash data
  • is_full
    Calculate whether a given combination of power and count corresponds to full DHT coverage.
  • pow2
    Convenience method for taking the power of 2 in u32
  • pow2f
    Convenience method for taking the power of 2 in f64
  • power_and_count_from_length
    Calculate the unique pairing of power and count implied by a given length and max number of chunks. Gives the nearest value that satisfies the constraints, but may not be exact.
  • power_and_count_from_length_exact
    Calculate the highest power and lowest count such that the given length is represented exactly. If the length is not representable even at the quantum level (power==0), return None.
  • print_arq
    Print ascii for arq bounds
  • print_arqs
    Print a collection of arqs
  • slice_xor
    Take bitwise XOR of each element of both slices

Type Aliases§