Documentation
¶
Overview ¶
Package util is a generated protocol buffer package.
It is generated from these files:
cockroach/util/unresolved_addr.proto
It has these top-level messages:
UnresolvedAddr
Index ¶
- Constants
- Variables
- func CleanupDir(dir string)
- func CreateRestrictedFile(t Tester, contents []byte, tempdir, name string) string
- func CreateTempDir(t Tester, prefix string) string
- func EqualPtrFields(src, dst reflect.Value, prefix string) []string
- func Errorf(format string, a ...interface{}) error
- func ErrorfSkipFrames(skip int, format string, a ...interface{}) error
- func FatalIfUnexpected(err error)
- func GetJSON(httpClient http.Client, path string, response proto.Message) error
- func IsClosedConnection(err error) bool
- func ListenAndServeGRPC(stopper *stop.Stopper, server *grpc.Server, addr net.Addr) (net.Listener, error)
- func MoveTopKToFront(data sort.Interface, k int)
- func NoZeroField(v interface{}) error
- func Pluralize(n int64) string
- func PostJSON(httpClient http.Client, path string, request, response proto.Message) error
- func RetryForDuration(duration time.Duration, fn func() error) error
- func StreamJSON(httpClient http.Client, path string, request proto.Message, dest proto.Message, ...) error
- func SucceedsSoon(t Tester, fn func() error)
- func SucceedsSoonDepth(depth int, t Tester, fn func() error)
- func TruncateDuration(d time.Duration, r time.Duration) time.Duration
- func UnimplementedWithIssueErrorf(issue int, msg string, args ...interface{}) error
- type JSONPb
- type ProtoPb
- type Server
- type Tester
- type UnimplementedWithIssueError
- type UnresolvedAddr
- func (*UnresolvedAddr) Descriptor() ([]byte, []int)
- func (m *UnresolvedAddr) Marshal() (data []byte, err error)
- func (m *UnresolvedAddr) MarshalTo(data []byte) (int, error)
- func (a *UnresolvedAddr) Network() string
- func (*UnresolvedAddr) ProtoMessage()
- func (m *UnresolvedAddr) Reset()
- func (a UnresolvedAddr) Resolve() (net.Addr, error)
- func (m *UnresolvedAddr) Size() (n int)
- func (a *UnresolvedAddr) String() string
- func (m *UnresolvedAddr) Unmarshal(data []byte) error
Constants ¶
const ( // AcceptHeader is the canonical header name for accept. AcceptHeader = "Accept" // AcceptEncodingHeader is the canonical header name for accept encoding. AcceptEncodingHeader = "Accept-Encoding" // ContentEncodingHeader is the canonical header name for content type. ContentEncodingHeader = "Content-Encoding" // ContentTypeHeader is the canonical header name for content type. ContentTypeHeader = "Content-Type" // JSONContentType is the JSON content type. JSONContentType = "application/json" // AltJSONContentType is the alternate JSON content type. AltJSONContentType = "application/x-json" // ProtoContentType is the protobuf content type. ProtoContentType = "application/x-protobuf" // AltProtoContentType is the alternate protobuf content type. AltProtoContentType = "application/x-google-protobuf" // PlaintextContentType is the plaintext content type. PlaintextContentType = "text/plain" // GzipEncoding is the gzip encoding. GzipEncoding = "gzip" )
Variables ¶
var ( ErrInvalidLengthUnresolvedAddr = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowUnresolvedAddr = fmt.Errorf("proto: integer overflow") )
var PanicTester = panicTesterImpl{}
PanicTester is a Tester which panics.
var TestAddr = NewUnresolvedAddr("tcp", "127.0.0.1:0")
TestAddr is an address to use for test servers. Listening on port 0 causes the kernel to allocate an unused port.
Functions ¶
func CleanupDir ¶
func CleanupDir(dir string)
CleanupDir removes the passed-in directory and all contents. Errors are ignored.
func CreateRestrictedFile ¶
CreateRestrictedFile creates a file on disk which contains the supplied byte string as its content. The resulting file will have restrictive permissions; specifically, u=rw (0600). Returns the path of the created file along with a function that will delete the created file.
This is needed for some Go libraries (e.g. postgres SQL driver) which will refuse to open certificate files that have overly permissive permissions.
func CreateTempDir ¶
CreateTempDir creates a temporary directory and returns its path. You should usually call defer CleanupDir(dir) right after.
func EqualPtrFields ¶
EqualPtrFields uses reflection to check two "mirror" structures for matching pointer fields that point to the same object. Used to verify cloning/deep copy functions.
func Errorf ¶
Errorf is a passthrough to fmt.Errorf, with an additional prefix containing the filename and line number.
func ErrorfSkipFrames ¶
ErrorfSkipFrames allows the skip count for stack frames to be specified. This is useful when generating errors via helper methods. Skip should be specified as the number of additional stack frames between the location at which the error is caused and the location at which the error is generated.
func FatalIfUnexpected ¶
func FatalIfUnexpected(err error)
FatalIfUnexpected calls Log.Fatal(err) unless err is nil, cmux.ErrListenerClosed, or the net package's errClosed.
func GetJSON ¶
GetJSON uses the supplied client to GET the URL specified by the parameters and unmarshals the result into response.
func IsClosedConnection ¶
IsClosedConnection returns true if err is cmux.ErrListenerClosed, grpc.ErrServerStopped, io.EOF, or the net package's errClosed.
func ListenAndServeGRPC ¶
func ListenAndServeGRPC(stopper *stop.Stopper, server *grpc.Server, addr net.Addr) (net.Listener, error)
ListenAndServeGRPC creates a listener and serves the specified grpc Server on it, closing the listener when signalled by the stopper.
func MoveTopKToFront ¶
MoveTopKToFront moves the top K elements to the front. It makes O(n) calls to data.Less and data.Swap (with very high probability). It uses Hoare's selection algorithm (aka quickselect).
func NoZeroField ¶
func NoZeroField(v interface{}) error
NoZeroField returns nil if none of the fields of the struct underlying the interface are equal to the zero value, and an error otherwise. It will panic if the struct has unexported fields and for any non-struct.
func PostJSON ¶
PostJSON uses the supplied client to POST request to the URL specified by the parameters and unmarshals the result into response .
func RetryForDuration ¶
RetryForDuration will retry the given function until it either returns without error, or the given duration has elapsed. The function is invoked immediately at first and then successively with an exponential backoff starting at 1ns and ending at the specified duration.
func StreamJSON ¶
func StreamJSON( httpClient http.Client, path string, request proto.Message, dest proto.Message, callback func(proto.Message), ) error
StreamJSON uses the supplied client to POST the given proto request as JSON to the supplied streaming grpc-gw endpoint; the response type serves only to create the values passed to the callback (which is invoked for every message in the stream with a value of the supplied response type masqueraded as an interface).
func SucceedsSoon ¶
SucceedsSoon fails the test (with t.Fatal) unless the supplied function runs without error within a preset maximum duration. The function is invoked immediately at first and then successively with an exponential backoff starting at 1ns and ending at the maximum duration (currently 15s).
func SucceedsSoonDepth ¶
SucceedsSoonDepth is like SucceedsSoon() but with an additional stack depth offset.
func TruncateDuration ¶
TruncateDuration returns a new duration obtained from the first argument by discarding the portions at finer resolution than that given by the second argument. Example: TruncateDuration(time.Second+1, time.Second) == time.Second.
func UnimplementedWithIssueErrorf ¶
UnimplementedWithIssueErrorf constructs an UnimplementedWithIssueError with the provided issue and formatted message.
Types ¶
type JSONPb ¶
JSONPb is a gwruntime.Marshaler that uses github.com/gogo/protobuf/jsonpb.
func (*JSONPb) ContentType ¶
ContentType implements gwruntime.Marshaler.
func (*JSONPb) NewDecoder ¶
NewDecoder implements gwruntime.Marshaler.
func (*JSONPb) NewEncoder ¶
NewEncoder implements gwruntime.Marshaler.
type ProtoPb ¶
type ProtoPb struct{}
ProtoPb is a gwruntime.Marshaler that uses github.com/gogo/protobuf/proto.
func (*ProtoPb) ContentType ¶
ContentType implements gwruntime.Marshaler.
func (*ProtoPb) NewDecoder ¶
NewDecoder implements gwruntime.Marshaler.
func (*ProtoPb) NewEncoder ¶
NewEncoder implements gwruntime.Marshaler.
type Server ¶
Server is a thin wrapper around http.Server. See MakeServer for more detail.
func MakeServer ¶
MakeServer constructs a Server that tracks active connections, closing them when signalled by stopper.
type Tester ¶
type Tester interface {
Error(args ...interface{})
Errorf(format string, args ...interface{})
Failed() bool
Fatal(args ...interface{})
Fatalf(format string, args ...interface{})
}
Tester is a proxy for e.g. testing.T which does not introduce a dependency on "testing".
type UnimplementedWithIssueError ¶
type UnimplementedWithIssueError struct {
// contains filtered or unexported fields
}
UnimplementedWithIssueError is an error that links unimplemented functionality back to its issue on GitHub.
func (UnimplementedWithIssueError) Error ¶
func (e UnimplementedWithIssueError) Error() string
type UnresolvedAddr ¶
type UnresolvedAddr struct {
NetworkField string `protobuf:"bytes,1,opt,name=network_field,json=networkField" json:"network_field"`
AddressField string `protobuf:"bytes,2,opt,name=address_field,json=addressField" json:"address_field"`
}
/ UnresolvedAddr is an unresolved version of net.Addr.
func MakeUnresolvedAddr ¶
func MakeUnresolvedAddr(network, addr string) UnresolvedAddr
MakeUnresolvedAddr populates an UnresolvedAddr from a network and raw address string.
func NewUnresolvedAddr ¶
func NewUnresolvedAddr(network, addr string) *UnresolvedAddr
NewUnresolvedAddr creates a new UnresolvedAddr from a network and raw address string.
func (*UnresolvedAddr) Descriptor ¶
func (*UnresolvedAddr) Descriptor() ([]byte, []int)
func (*UnresolvedAddr) Marshal ¶
func (m *UnresolvedAddr) Marshal() (data []byte, err error)
func (*UnresolvedAddr) Network ¶
func (a *UnresolvedAddr) Network() string
Network returns the address's network name.
func (*UnresolvedAddr) ProtoMessage ¶
func (*UnresolvedAddr) ProtoMessage()
func (*UnresolvedAddr) Reset ¶
func (m *UnresolvedAddr) Reset()
func (UnresolvedAddr) Resolve ¶
func (a UnresolvedAddr) Resolve() (net.Addr, error)
Resolve attempts to resolve a into a net.Addr.
func (*UnresolvedAddr) Size ¶
func (m *UnresolvedAddr) Size() (n int)
func (*UnresolvedAddr) String ¶
func (a *UnresolvedAddr) String() string
String returns the address's string form.
func (*UnresolvedAddr) Unmarshal ¶
func (m *UnresolvedAddr) Unmarshal(data []byte) error
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package hlc implements the Hybrid Logical Clock outlined in "Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases", available online at http://www.cse.buffalo.edu/tech-reports/2014-04.pdf.
|
Package hlc implements the Hybrid Logical Clock outlined in "Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases", available online at http://www.cse.buffalo.edu/tech-reports/2014-04.pdf. |
|
Package interval implements an interval tree based on an augmented Left-Leaning Red Black tree.
|
Package interval implements an interval tree based on an augmented Left-Leaning Red Black tree. |
|
Package leaktest provides tools to detect leaked goroutines in tests.
|
Package leaktest provides tools to detect leaked goroutines in tests. |
|
Package log implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.
|
Package log implements logging analogous to the Google-internal C++ INFO/ERROR/V setup. |
|
Package metric provides server metrics (a.k.a.
|
Package metric provides server metrics (a.k.a. |
|
Package sdnotify implements both sides of the systemd readiness protocol.
|
Package sdnotify implements both sides of the systemd readiness protocol. |
|
Package tracing is a generated protocol buffer package.
|
Package tracing is a generated protocol buffer package. |