contact

Documentation

Index

• Variables
• type Config
• type Endpoint
  • func NewEndpoint(log *zap.Logger, service *Service) *Endpoint
  • func (endpoint *Endpoint) CheckIn(ctx context.Context, req *pb.CheckInRequest) (_ *pb.CheckInResponse, err error)
  • func (endpoint *Endpoint) GetTime(ctx context.Context, req *pb.GetTimeRequest) (_ *pb.GetTimeResponse, err error)
  • func (endpoint *Endpoint) PingMe(ctx context.Context, req *pb.PingMeRequest) (_ *pb.PingMeResponse, err error)
• type RateLimiter
  • func NewRateLimiter(interval time.Duration, burst, numLimits int) *RateLimiter
  • func (rateLimiter *RateLimiter) IsAllowed(ctx context.Context, key string) bool
• type Service
  • func NewService(log *zap.Logger, self *overlay.NodeDossier, overlay *overlay.Service, ...) *Service
  • func (service *Service) Close() error
  • func (service *Service) Local() overlay.NodeDossier
  • func (service *Service) PingBack(ctx context.Context, nodeurl storj.NodeURL) (_ bool, _ bool, _ string, err error)

Variables

var (
	// Error is the default error class for contact package.
	Error = errs.Class("contact")
)

Types

type Config

type Config struct {
	ExternalAddress string        `user:"true" help:"the public address of the node, useful for nodes behind NAT" default:""`
	Timeout         time.Duration `help:"timeout for pinging storage nodes" default:"10m0s" testDefault:"1m"`
	AllowPrivateIP  bool          `help:"allow private IPs in CheckIn and PingMe" testDefault:"true" devDefault:"true" default:"false"`

	RateLimitInterval  time.Duration `help:"the amount of time that should happen between contact attempts usually" releaseDefault:"10m0s" devDefault:"1ns"`
	RateLimitBurst     int           `help:"the maximum burst size for the contact rate limit token bucket" releaseDefault:"2" devDefault:"1000"`
	RateLimitCacheSize int           `help:"the number of nodes or addresses to keep token buckets for" default:"1000"`
}

Config contains configurable values for contact service.

type Endpoint

type Endpoint struct {
	pb.DRPCNodeUnimplementedServer
	// contains filtered or unexported fields
}

Endpoint implements the contact service Endpoints.

func NewEndpoint

func NewEndpoint(log *zap.Logger, service *Service) *Endpoint

NewEndpoint returns a new contact service endpoint.

func (*Endpoint) CheckIn

func (endpoint *Endpoint) CheckIn(ctx context.Context, req *pb.CheckInRequest) (_ *pb.CheckInResponse, err error)

CheckIn is periodically called by storage nodes to keep the satellite informed of its existence, address, and operator information. In return, this satellite keeps the node informed of its reachability. When a node checks-in with the satellite, the satellite pings the node back to confirm they can successfully connect.

func (*Endpoint) GetTime

func (endpoint *Endpoint) GetTime(ctx context.Context, req *pb.GetTimeRequest) (_ *pb.GetTimeResponse, err error)

GetTime returns current timestamp.

func (*Endpoint) PingMe

func (endpoint *Endpoint) PingMe(ctx context.Context, req *pb.PingMeRequest) (_ *pb.PingMeResponse, err error)

PingMe is called by storage node to request a pingBack from the satellite to confirm they can successfully connect to the node.

type RateLimiter

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

RateLimiter allows to prevent multiple events in fixed period of time.

func NewRateLimiter

func NewRateLimiter(interval time.Duration, burst, numLimits int) *RateLimiter

NewRateLimiter is a constructor for RateLimiter.

func (*RateLimiter) IsAllowed

func (rateLimiter *RateLimiter) IsAllowed(ctx context.Context, key string) bool

IsAllowed indicates if event is allowed to happen.

type Service

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

Service is the contact service between storage nodes and satellites. It is responsible for updating general node information like address and capacity. It is also responsible for updating peer identity information for verifying signatures from that node.

architecture: Service

func NewService

func NewService(log *zap.Logger, self *overlay.NodeDossier, overlay *overlay.Service, peerIDs overlay.PeerIdentities, dialer rpc.Dialer, authority nodetag.Authority, config Config) *Service

NewService creates a new contact service.

func (*Service) Close

func (service *Service) Close() error

Close closes resources.

func (*Service) Local

func (service *Service) Local() overlay.NodeDossier

Local returns the satellite node dossier.

func (*Service) PingBack

func (service *Service) PingBack(ctx context.Context, nodeurl storj.NodeURL) (_ bool, _ bool, _ string, err error)

PingBack pings the node to test connectivity.