protocol

Documentation

Index

• func CompositeCloser(closers ...io.Closer) io.Closer
• func ForwarderDims(name string, typ string) map[string]string
• func ListenerDims(name string, typ string) map[string]string
• type CompositeForwarder
• type CompositeListener
• type Forwarder
• type Listener
• type OkCloser
  • func (o OkCloser) Close() error

Functions

func CompositeCloser

func CompositeCloser(closers ...io.Closer) io.Closer

CompositeCloser creates a new io.Closer whos Close() method calls close of each of the closers

func ForwarderDims

func ForwarderDims(name string, typ string) map[string]string

ForwarderDims are the common stat dimensions we expect on forwarder protocols

func ListenerDims

func ListenerDims(name string, typ string) map[string]string

ListenerDims are the common stat dimensions we expect on listener protocols

Types

type CompositeForwarder

type CompositeForwarder struct {
	dpsink.Sink
	stats.Keeper
	io.Closer
}

CompositeForwarder is a helper struct that expects users to inject their own versions of each type

type CompositeListener

type CompositeListener struct {
	stats.Keeper
	io.Closer
}

CompositeListener is a helper struct that expects users to inject their own versions of each type

type Forwarder

type Forwarder interface {
	dpsink.Sink
	stats.Keeper
	io.Closer
}

Forwarder is the basic interface endpoints must support for the proxy to forward to them

type Listener

type Listener interface {
	stats.Keeper
	io.Closer
}

Listener is the basic interface anything that listens for new metrics must implement

type OkCloser

type OkCloser func()

OkCloser allows any function to become a io.Closer that returns nil and calls itself on close

func (OkCloser) Close

func (o OkCloser) Close() error

Close calls the wrapped function and returns nil