contact

Documentation

Index

• Variables
• type Endpoint
  • func NewEndpoint(log *zap.Logger, service *Service) *Endpoint
  • func (endpoint *Endpoint) CheckIn(ctx context.Context, req *pb.CheckInRequest) (_ *pb.CheckInResponse, err error)
• type Service
  • func NewService(log *zap.Logger, overlay *overlay.Service, peerIDs overlay.PeerIdentities, ...) *Service

Variables

var Error = errs.Class("contact")

Error is the default error class for contact package.

Types

type Endpoint

type Endpoint struct {
	// 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.

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, capacity, and uptime. It is also responsible for updating peer identity information for verifying signatures from that node.

architecture: Service

func NewService

func NewService(log *zap.Logger, overlay *overlay.Service, peerIDs overlay.PeerIdentities, transport transport.Client) *Service

NewService creates a new contact service.