Skip to content

Commit

Permalink
README.md: few more link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
willgreenberg committed Aug 16, 2019
1 parent ac7ef67 commit 66088b2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ When [`Get`] is called for a key in a [`Galaxy`] in some process called Process_
- If the Process_A is the authority:
- Process_A uses its [`BackendGetter`] to get the data, and populates its local maincache
- If Process_A is _not_ the authority:
- Process_A calls `Fetch` on the authoritative remote peer, Process_B (method determined by [`FetchProtocol`](https://godoc.org/github.com/vimeo/galaxycache#FetchProtocol))
- Process_A calls `Fetch` on the authoritative remote peer, Process_B (method determined by [`FetchProtocol`])
- Process_B then performs a [`Get`] to either find the data from its own local cache or use the specified [`BackendGetter`] to get the data from elsewhere, such as by querying a database
- Process_B populates its maincache with the data before serving it back to Process_A
- Process_A determines whether the key is hot enough to promote to the hotcache
Expand All @@ -123,7 +123,7 @@ Our changes include the following:
### New architecture and API

* Renamed `Group` type to [`Galaxy`], `Getter` to [`BackendGetter`], `Get` to `Fetch` (for newly named [`RemoteFetcher`] interface, previously called `ProtoGetter`)
* Reworked [`PeerPicker`] interface into a struct; contains a [`FetchProtocol`] and [`RemoteFetchers`] (generalizing for HTTP and GRPC fetching implementations), a hash map of other peer addresses, and a self URL
* Reworked [`PeerPicker`] interface into a struct; contains a [`FetchProtocol`] and [`RemoteFetchers`](https://godoc.org/github.com/vimeo/galaxycache#RemoteFetcher) (generalizing for HTTP and GRPC fetching implementations), a hash map of other peer addresses, and a self URL

### No more global state

Expand All @@ -132,8 +132,8 @@ Our changes include the following:

### New structure for fetching from peers (with gRPC support)

* Added an [`HTTPHandler`] and associated registration function for serving HTTP requests by reaching into an associated [`Universe`] (deals with the other function of the deprecated `HTTPPool`)
* Added [gRPC support](https://godoc.org/github.com/vimeo/galaxycache/grpc) for peer communication
* Added an [`HTTPHandler`](https://godoc.org/github.com/vimeo/galaxycache/http#HTTPHandler) and associated [registration function](https://godoc.org/github.com/vimeo/galaxycache/http#RegisterHTTPHandler) for serving HTTP requests by reaching into an associated [`Universe`] (deals with the other function of the deprecated `HTTPPool`)
* Added [gRPC support](https://godoc.org/github.com/vimeo/galaxycache/grpc) for peer communication, with a function for [gRPC server registration](https://godoc.org/github.com/vimeo/galaxycache/grpc#RegisterGRPCServer)
* Reworked tests to fit new architecture
* Renamed files to match new type names

Expand All @@ -158,6 +158,7 @@ Use the golang-nuts mailing list for any discussion or questions.
[`Get`]:https://godoc.org/github.com/vimeo/galaxycache#Galaxy.Get
[`PeerPicker`]:https://godoc.org/github.com/vimeo/galaxycache#PeerPicker
[`Codec`]:https://godoc.org/github.com/vimeo/galaxycache#Codec
[`FetchProtocol`]:https://godoc.org/github.com/vimeo/galaxycache#FetchProtocol)
[`RemoteFetcher`]:https://godoc.org/github.com/vimeo/galaxycache#RemoteFetcher
[`BackendGetter`]:https://godoc.org/github.com/vimeo/galaxycache#BackendGetter
[`ShouldPromote.Interface`]:https://godoc.org/github.com/vimeo/galaxycache/promoter#Interface
Expand Down

0 comments on commit 66088b2

Please sign in to comment.