README
¶
Pool
Services and Applications
An application has a user interface, it's something that users care about. A service runs in the background. A program is either a service or application.
All programs are issued a port to communicate on. Pool will only respond to requests from that port. They are all issued their key at startup. A program should not store their key anywhere else.
Documentation
¶
Overview ¶
Package pool provides an instance of Pool. It is intended to be wrapped by an OS/Platform specific interface.
Package pool is a generated protocol buffer package.
It is generated from these files:
pool/program.proto
It has these top-level messages:
Program
Index ¶
- Constants
- Variables
- func Dir() string
- func IsSetup() bool
- func SaltFile() string
- type Pool
- func (p *Pool) Add(prog *Program) error
- func (p *Pool) AddBeacon(addr *rnet.Addr, key *crypto.XchgPub)
- func (p *Pool) ExitAll()
- func (p *Pool) GetIP(from *rnet.Addr) *rnet.Addr
- func (p *Pool) GetOverlayNetPort() uint32
- func (p *Pool) GetOverlayPubKey() string
- func (p *Pool) OverlayRandomKey()
- func (p *Pool) OverlayStaticKey()
- func (p *Pool) QueryHandler(q ipcrouter.Query)
- func (p *Pool) Run()
- func (*Pool) ServiceID() uint32
- type Program
- func (*Program) Descriptor() ([]byte, []int)
- func (m *Program) GetImplements() []string
- func (m *Program) GetKey() []byte
- func (m *Program) GetLocation() string
- func (m *Program) GetName() string
- func (m *Program) GetPort32() uint32
- func (m *Program) GetStart() bool
- func (m *Program) GetUI() bool
- func (p *Program) Port() rnet.Port
- func (p *Program) PortStr() string
- func (*Program) ProtoMessage()
- func (m *Program) Reset()
- func (m *Program) String() string
Constants ¶
const ErrBadSetup = errors.String("Bad setup")
ErrBadSetup will be returned if the merkle forrest ccannot be read
Variables ¶
var LogFile = prog.Root() + "pool.log"
LogFile for pool log
var Port = rnet.Port(3000)
Port that pool will run on, should be moved to config
Functions ¶
Types ¶
type Pool ¶
Pool coordinates all local resources for dist.ribut.us
func (*Pool) ExitAll ¶
func (p *Pool) ExitAll()
ExitAll sends an exit message to all service, whether they are running or not (closes stray programs from previous)
func (*Pool) GetOverlayNetPort ¶
GetOverlayNetPort gets the network port
func (*Pool) GetOverlayPubKey ¶
GetOverlayPubKey gets the public key for the network
func (*Pool) OverlayRandomKey ¶
func (p *Pool) OverlayRandomKey()
OverlayRandomKey tells the overlay service to use a random key
func (*Pool) OverlayStaticKey ¶
func (p *Pool) OverlayStaticKey()
OverlayStaticKey tells the overlay service to use a static key
func (*Pool) QueryHandler ¶
QueryHandler for ipc queries to Pool service
type Program ¶
type Program struct {
Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"`
Location string `protobuf:"bytes,2,opt,name=Location" json:"Location,omitempty"`
UI bool `protobuf:"varint,3,opt,name=UI" json:"UI,omitempty"`
Key []byte `protobuf:"bytes,4,opt,name=Key,proto3" json:"Key,omitempty"`
Port32 uint32 `protobuf:"varint,5,opt,name=Port32" json:"Port32,omitempty"`
Start bool `protobuf:"varint,6,opt,name=Start" json:"Start,omitempty"`
Implements []string `protobuf:"bytes,7,rep,name=Implements" json:"Implements,omitempty"`
}
func (*Program) Descriptor ¶
func (*Program) GetImplements ¶
func (*Program) GetLocation ¶
func (*Program) ProtoMessage ¶
func (*Program) ProtoMessage()
Source Files
Directories