beachcomber 0.5.1

A centralized daemon that caches shell state (git, battery, hostname, etc.) so every consumer reads from one fast cache instead of independently forking shells
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

package beachcomber

import (
	"bufio"
	"net"
)

// Session holds a persistent connection to the daemon. It is not safe for
// concurrent use; create one session per goroutine (or protect access with a
// mutex).
//
// A session is obtained via [Client.Session]:
//
//	sess, err := client.Session()
//	if err != nil { … }
//	defer sess.Close()
type Session struct {
	conn    net.Conn
	scanner *bufio.Scanner
}

// Get reads a cached value. path="" omits the path field.
func (s *Session) Get(key string, path string) (*Result, error) {
	req := map[string]interface{}{"op": "get", "key": key}
	if path != "" {
		req["path"] = path
	}
	return s.roundtrip(req)
}

// Poke forces the daemon to recompute the given provider/key.
func (s *Session) Poke(key string, path string) error {
	req := map[string]interface{}{"op": "poke", "key": key}
	if path != "" {
		req["path"] = path
	}
	_, err := s.roundtrip(req)
	return err
}

// SetContext sends a "context" message, which sets the default path for all
// subsequent queries on this connection. This avoids repeating the path in
// every Get/Poke call.
func (s *Session) SetContext(path string) error {
	_, err := s.roundtrip(map[string]interface{}{"op": "context", "path": path})
	return err
}

// Close closes the underlying connection.
func (s *Session) Close() error {
	return s.conn.Close()
}

func (s *Session) roundtrip(req map[string]interface{}) (*Result, error) {
	if err := writeJSON(s.conn, req); err != nil {
		return nil, err
	}
	return readResponse(s.scanner)
}