contact

Documentation

Index

• Variables
• type Chore
  • func NewChore(log *zap.Logger, interval time.Duration, maxSleep time.Duration, ...) *Chore
  • func (chore *Chore) Close() error
  • func (chore *Chore) Run(ctx context.Context) (err error)
• type Config
• type Endpoint
  • func NewEndpoint(log *zap.Logger, pingStats *PingStats) *Endpoint
  • func (endpoint *Endpoint) PingNode(ctx context.Context, req *pb.ContactPingRequest) (_ *pb.ContactPingResponse, err error)
• type KademliaEndpoint
  • func NewKademliaEndpoint(log *zap.Logger, service *Service, trust SatelliteIDVerifier) *KademliaEndpoint
  • func (endpoint *KademliaEndpoint) Ping(ctx context.Context, req *pb.PingRequest) (_ *pb.PingResponse, err error)
  • func (endpoint *KademliaEndpoint) Query(ctx context.Context, req *pb.QueryRequest) (_ *pb.QueryResponse, err error)
  • func (endpoint *KademliaEndpoint) RequestInfo(ctx context.Context, req *pb.InfoRequest) (_ *pb.InfoResponse, err error)
• type PingStats
  • func (stats *PingStats) WasPinged(when time.Time)
  • func (stats *PingStats) WhenLastPinged() (when time.Time)
• type SatelliteIDVerifier
• type Service
  • func NewService(log *zap.Logger, self *overlay.NodeDossier) *Service
  • func (service *Service) Local() overlay.NodeDossier
  • func (service *Service) UpdateSelf(capacity *pb.NodeCapacity)

Variables

var Error = errs.Class("contact")

Error is the default error class for contact package

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore is the contact chore for nodes announcing themselves to their trusted satellites

architecture: Chore

func NewChore

func NewChore(log *zap.Logger, interval time.Duration, maxSleep time.Duration, trust *trust.Pool, dialer rpc.Dialer, service *Service) *Chore

NewChore creates a new contact chore

func (*Chore) Close

func (chore *Chore) Close() error

Close stops the contact chore

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run the contact chore on a regular interval with jitter

type Config

type Config struct {
	ExternalAddress string `user:"true" help:"the public address of the node, useful for nodes behind NAT" default:""`

	// Chore config values
	Interval time.Duration `help:"how frequently the node contact chore should run" releaseDefault:"1h" devDefault:"30s"`
	// MaxSleep should remain at default value to decrease traffic congestion to satellite
	MaxSleep time.Duration `help:"maximum duration to wait before pinging satellites" releaseDefault:"45m" devDefault:"0s" hidden:"true"`
}

Config contains configurable values for contact service

type Endpoint

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

Endpoint implements the contact service Endpoints

architecture: Endpoint

func NewEndpoint

func NewEndpoint(log *zap.Logger, pingStats *PingStats) *Endpoint

NewEndpoint returns a new contact service endpoint

func (*Endpoint) PingNode

func (endpoint *Endpoint) PingNode(ctx context.Context, req *pb.ContactPingRequest) (_ *pb.ContactPingResponse, err error)

PingNode provides an easy way to verify a node is online and accepting requests

type KademliaEndpoint

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

KademliaEndpoint implements the NodesServer Interface for backwards compatibility

func NewKademliaEndpoint

func NewKademliaEndpoint(log *zap.Logger, service *Service, trust SatelliteIDVerifier) *KademliaEndpoint

NewKademliaEndpoint returns a new endpoint

func (*KademliaEndpoint) Ping

func (endpoint *KademliaEndpoint) Ping(ctx context.Context, req *pb.PingRequest) (_ *pb.PingResponse, err error)

Ping provides an easy way to verify a node is online and accepting requests

func (*KademliaEndpoint) Query

func (endpoint *KademliaEndpoint) Query(ctx context.Context, req *pb.QueryRequest) (_ *pb.QueryResponse, err error)

Query is a node to node communication query

func (*KademliaEndpoint) RequestInfo

func (endpoint *KademliaEndpoint) RequestInfo(ctx context.Context, req *pb.InfoRequest) (_ *pb.InfoResponse, err error)

RequestInfo returns the node info

type PingStats

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

PingStats contains information regarding when the node was last pinged

func (*PingStats) WasPinged

func (stats *PingStats) WasPinged(when time.Time)

WasPinged notifies the service it has been remotely pinged.

func (*PingStats) WhenLastPinged

func (stats *PingStats) WhenLastPinged() (when time.Time)

WhenLastPinged returns last time someone pinged this node.

type SatelliteIDVerifier

type SatelliteIDVerifier interface {
	VerifySatelliteID(ctx context.Context, id storj.NodeID) error
}

SatelliteIDVerifier checks if the connection is from a trusted satellite

type Service

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

Service is the contact service between storage nodes and satellites

func NewService

func NewService(log *zap.Logger, self *overlay.NodeDossier) *Service

NewService creates a new contact service

func (*Service) Local

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

Local returns the storagenode node-dossier

func (*Service) UpdateSelf

func (service *Service) UpdateSelf(capacity *pb.NodeCapacity)

UpdateSelf updates the local node with the capacity