Skip to content

Commit

Permalink
docs: remove mentions of coral, it's not implemented
Browse files Browse the repository at this point in the history
  • Loading branch information
Lars Gierth committed Mar 28, 2018
1 parent 25416c3 commit db3b915
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 5 deletions.
4 changes: 2 additions & 2 deletions dht.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Package dht implements a distributed hash table that satisfies the ipfs routing
// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
// interface. This DHT is modeled after kademlia with S/Kademlia modifications.
package dht

import (
Expand Down Expand Up @@ -40,7 +40,7 @@ var ProtocolDHTOld protocol.ID = "/ipfs/dht"
// collect members of the routing table.
const NumBootstrapQueries = 5

// IpfsDHT is an implementation of Kademlia with Coral and S/Kademlia modifications.
// IpfsDHT is an implementation of Kademlia with S/Kademlia modifications.
// It is used to implement the base IpfsRouting module.
type IpfsDHT struct {
host host.Host // the network services we need
Expand Down
2 changes: 1 addition & 1 deletion dht_bootstrap.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Package dht implements a distributed hash table that satisfies the ipfs routing
// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
// interface. This DHT is modeled after Kademlia with S/Kademlia modifications.
package dht

import (
Expand Down
1 change: 1 addition & 0 deletions pb/dht.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pb/dht.proto
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ message Message {
optional MessageType type = 1;

// defines what coral cluster level this query/response belongs to.
// in case we want to implement coral's cluster rings in the future.
optional int32 clusterLevelRaw = 10;

// Used to specify the key associated with this message.
Expand Down
5 changes: 3 additions & 2 deletions routing.go
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,9 @@ func (dht *IpfsDHT) GetValues(ctx context.Context, key string, nvals int) (_ []r
return vals, nil
}

// Value provider layer of indirection.
// This is what DSHTs (Coral and MainlineDHT) do to store large values in a DHT.
// Provider abstraction for indirect stores.
// Some DHTs store values directly, while an indirect store stores pointers to
// locations of the value, similarly to Coral and Mainline DHT.

// Provide makes this node announce that it can provide a value for the given key
func (dht *IpfsDHT) Provide(ctx context.Context, key *cid.Cid, brdcst bool) (err error) {
Expand Down

0 comments on commit db3b915

Please sign in to comment.