ring

Documentation

Index

• func BootstrapRingpop(rp *ringpop.Ringpop, provider discovery.DiscoverProvider) error
• func NewChannel() (*tchannel.Channel, error)
• func NewRingpop(ch *tchannel.Channel, ringpopPeerIP, ringpopPeerPort string, ...) (*ringpop.Ringpop, error)
• func RequestToKey(r *http.Request) string
• func ResolveDestinationNode(rp *ringpop.Ringpop, key string) (string, error)
• func SetLogger(logger bark.Logger)
• type Forwarder
• type HTTPResponseWriter
  • func NewResponseWriter() *HTTPResponseWriter
  • func (r *HTTPResponseWriter) Header() http.Header
  • func (r *HTTPResponseWriter) Response() *http.Response
  • func (r *HTTPResponseWriter) Write(body []byte) (int, error)
  • func (r *HTTPResponseWriter) WriteHeader(status int)
• type RequestForwarder
  • func NewForwarder(rp *ringpop.Ringpop, l bark.Logger) *RequestForwarder
  • func (f *RequestForwarder) Forward(node, key string, request []byte) ([]byte, error)
• type Server
  • func NewServer(ch *tchannel.Channel, backend http.Handler, logger bark.Logger) *Server
  • func (srv *Server) ListenAndServe(hostPort string) error

Functions

func BootstrapRingpop

func BootstrapRingpop(rp *ringpop.Ringpop, provider discovery.DiscoverProvider) error

Bootstrap starts communication for this Ringpop instance. When Bootstrap is called, this Ringpop instance will attempt to contact other instances from the DiscoverProvider.

func NewChannel

func NewChannel() (*tchannel.Channel, error)

NewChannel returns new TChannel used for communication between nodes in ring

func NewRingpop

func NewRingpop(ch *tchannel.Channel, ringpopPeerIP, ringpopPeerPort string, logger bark.Logger) (*ringpop.Ringpop, error)

NewRingpop returns new ringpop

func RequestToKey

func RequestToKey(r *http.Request) string

RequestToKey converts request to key, that will be used for hash ring This func uses client IP as key

func ResolveDestinationNode

func ResolveDestinationNode(rp *ringpop.Ringpop, key string) (string, error)

ResolveDestinationNode finds out responsible node from hashring by given key

func SetLogger

func SetLogger(logger bark.Logger)

SetLogger sets default logger for ringpop

Types

type Forwarder

type Forwarder interface {
	Forward(node, key string, request []byte) ([]byte, error)
}

Forwarder is a request forwarder used to transfer request between nodes in hashring

type HTTPResponseWriter

type HTTPResponseWriter struct {
	// contains filtered or unexported fields
}

HTTPResponseWriter is a simple http.ResponseWriter implementation

func NewResponseWriter

func NewResponseWriter() *HTTPResponseWriter

NewResponseWriter returns new HTTP ResponseWriter

func (*HTTPResponseWriter) Header

func (r *HTTPResponseWriter) Header() http.Header

func (*HTTPResponseWriter) Response

func (r *HTTPResponseWriter) Response() *http.Response

func (*HTTPResponseWriter) Write

func (r *HTTPResponseWriter) Write(body []byte) (int, error)

func (*HTTPResponseWriter) WriteHeader

func (r *HTTPResponseWriter) WriteHeader(status int)

type RequestForwarder

type RequestForwarder struct {
	// contains filtered or unexported fields
}

RequestForwarder is a simple request forwarder that transfers request between nodes using ringpop

func NewForwarder

func NewForwarder(rp *ringpop.Ringpop, l bark.Logger) *RequestForwarder

NewForwarder returns new request forwarder

func (*RequestForwarder) Forward

func (f *RequestForwarder) Forward(node, key string, request []byte) ([]byte, error)

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server serves ringpop (gossip) requests inside ring

func NewServer

func NewServer(ch *tchannel.Channel, backend http.Handler, logger bark.Logger) *Server

NewServer returns new ringpop server and registers its handlers

func (*Server) ListenAndServe

func (srv *Server) ListenAndServe(hostPort string) error

ListenAndServe starts listening on TChannel