Documentation
¶
Overview ¶
Package service defines a service for the P2P relay circuit, which enables nodes to send traffic through intermediary nodes in order to reach otherwise inaccessible nodes.
Index ¶
- Variables
- type Config
- type Host
- type Service
- func (s *Service) Config() interface{}
- func (s *Service) Desc() string
- func (s *Service) ID() string
- func (s *Service) Name() string
- func (s *Service) Needs() map[string]struct{}
- func (s *Service) Plug(exposed map[string]interface{}) error
- func (s *Service) Run(ctx context.Context, running, stopping func()) error
- func (s *Service) SetConfig(config interface{}) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNotHost is returned when the connected service is not a host. ErrNotHost = errors.New("connected service is not a host") )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Host is the name of the host service.
Host string `toml:"host" comment:"The name of the host service."`
// EnableHop is whether to act as an intermediary node in relay
// circuits.
EnableHop bool `toml:"enable_hop" comment:"Whether to act as an intermediary node in relay circuits."`
}
Config contains configuration options for the Relay service.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service is the Relay service.
func (*Service) Config ¶
func (s *Service) Config() interface{}
Config returns the current service configuration or creates one with good default values.
Source Files
Click to show internal directories.
Click to hide internal directories.