comments

License: MIT Signed-off-by: Jeromy <jeromyj@gmail.com>
ipfs · Feb 3, 2018 · a703e2d · a703e2d
1 parent 1de040d
commit a703e2d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/merkledag/merkledag.go b/merkledag/merkledag.go
@@ -146,6 +146,7 @@ func (sg *sesGetter) GetMany(ctx context.Context, keys []*cid.Cid) <-chan *ipld.
 	return getNodesFromBG(ctx, sg.bs, keys)
 }
 
+// Session returns a NodeGetter using a new session for block fetches.
 func (ds *dagService) Session(ctx context.Context) ipld.NodeGetter {
 	return &sesGetter{bserv.NewSession(ctx, ds.Blocks)}
 }

diff --git a/merkledag/readonly.go b/merkledag/readonly.go
@@ -6,8 +6,12 @@ import (
 	ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
 )
 
+// ErrReadOnly is used when a read-only datastructure is written to.
 var ErrReadOnly = fmt.Errorf("cannot write to readonly DAGService")
 
+// NewReadOnlyDagService takes a NodeGetter, and returns a full DAGService
+// implementation that returns ErrReadOnly when its 'write' methods are
+// invoked.
 func NewReadOnlyDagService(ng ipld.NodeGetter) ipld.DAGService {
 	return &ComboService{
 		Read:  ng,

diff --git a/merkledag/session.go b/merkledag/session.go
@@ -6,10 +6,13 @@ import (
 	ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
 )
 
+// SessionMaker is an object that can generate a new fetching session.
 type SessionMaker interface {
 	Session(context.Context) ipld.NodeGetter
 }
 
+// NewSession returns a session backed NodeGetter if the given NodeGetter
+// implements SessionMaker.
 func NewSession(ctx context.Context, g ipld.NodeGetter) ipld.NodeGetter {
 	if sm, ok := g.(SessionMaker); ok {
 		return sm.Session(ctx)