Categorygithub.com/hashicorp/serfclient
package
0.10.2
Repository: https://github.com/hashicorp/serf.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
45
Files
910 SLOC

# README

Serf Client

This repo provide the client package, which is used to interact with a Serf agent using the msgpack RPC system it supports. This is the official reference implementation, and is used inside the Serf CLI to support the various commands.

Full documentation can be found on godoc here.

# Functions

ClientFromConfig is used to create a new RPC client given the configuration object.
NewRPCClient is used to create a new RPC client given the RPC address of the Serf agent.

# Constants

This is the default IO timeout for the client.

# Structs

Config is provided to ClientFromConfig to make a new RPCClient from the given configuration.
Member is used to represent a single member of the Serf cluster.
NodeResponse is used to return the response of a query.
QueryParam is provided to query set various settings.
RPCClient is used to make requests to the Agent using an RPC mechanism.

# Type aliases

StreamHandle is an opaque handle passed to stop to stop streaming.