mirror of https://github.com/status-im/consul.git
deb43fea6b
Cancellation channels are often derived from a Context, which
returns a directional `<-chan struct{}` from Done(). In order to use
this with parts of of the consul API, one is required to create a new
channel and dispatch a separate goroutine to watch for context
cancellation and close the new channel.
Changing the signature for the methods that take cancellation channels
will allow easier integration with existing uses of Context. Since the
cancellation pattern only reads from these channels, there should be no
backwards incompatibility with existing codebases, and most of the
methods already accept only the correct type.
|
||
|---|---|---|
| .. | ||
| README.md | ||
| acl.go | ||
| acl_test.go | ||
| agent.go | ||
| agent_test.go | ||
| api.go | ||
| api_test.go | ||
| catalog.go | ||
| catalog_test.go | ||
| coordinate.go | ||
| coordinate_test.go | ||
| event.go | ||
| event_test.go | ||
| health.go | ||
| health_test.go | ||
| kv.go | ||
| kv_test.go | ||
| lock.go | ||
| lock_test.go | ||
| operator.go | ||
| operator_area.go | ||
| operator_autopilot.go | ||
| operator_autopilot_test.go | ||
| operator_keyring.go | ||
| operator_keyring_test.go | ||
| operator_raft.go | ||
| operator_raft_test.go | ||
| prepared_query.go | ||
| prepared_query_test.go | ||
| raw.go | ||
| semaphore.go | ||
| semaphore_test.go | ||
| session.go | ||
| session_test.go | ||
| snapshot.go | ||
| snapshot_test.go | ||
| status.go | ||
| status_test.go | ||
README.md
Consul API client
This package provides the api package which attempts to
provide programmatic access to the full Consul API.
Currently, all of the Consul APIs included in version 0.6.0 are supported.
Documentation
The full documentation is available on Godoc
Usage
Below is an example of using the Consul client:
// Get a new client
client, err := api.NewClient(api.DefaultConfig())
if err != nil {
panic(err)
}
// Get a handle to the KV API
kv := client.KV()
// PUT a new KV pair
p := &api.KVPair{Key: "foo", Value: []byte("test")}
_, err = kv.Put(p, nil)
if err != nil {
panic(err)
}
// Lookup the pair
pair, _, err := kv.Get("foo", nil)
if err != nil {
panic(err)
}
fmt.Printf("KV: %v", pair)