fleet

package module
v0.6.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2022 License: MIT Imports: 47 Imported by: 1

README

Fleet system

Allows peers to connect to each other when run within a fleet system.

Documentation

See: https://godoc.org/github.com/KarpelesLab/fleet

Documentation

Index

Constants

View Source 
const (
	PacketMaxLen = 32 * 1024 * 1024 // 32MB

	PacketLegacy = 0xffff // legacy gob-encoded packet
	PacketPing   = 0x1001
	PacketPong   = 0x3001
	PacketClose  = 0x1fff

	PacketCustom    = 0xa000 // 0xa000 ~ 0xafff are custom channels
	PacketCustomMax = 0xafff
)
View Source 
const UUID_SEEDID_SPACE = "da736663-83ec-46ef-9c29-3f9102c5c519"

Variables

View Source 
var (
	ErrWriteQueueFull   = errors.New("peer write queue is full")
	ErrPeerNoRoute      = errors.New("no route to peer")
	ErrConnectionClosed = errors.New("connection has been closed")
	ErrInvalidLegacy    = errors.New("invalid operation on legacy peer")
)

Functions

func CallRpcEndpoint added in v0.3.23 

func CallRpcEndpoint(e string, p interface{}) (res interface{}, err error)

CallRpcEndpoint will call the named RPC endpoint on the local machine

func Custom added in v0.5.12 

func Custom(v uint16) uint16

Custom returns a packet id for a given custom packet Typically you will define your custom packet as follow: 

var MyCustomPacket = fleet.Custom(0)

func EnsureDir 

func EnsureDir(c string) error

func SetCustomHandler added in v0.5.12 

func SetCustomHandler(pc uint16, h CustomHandler)

func SetRpcEndpoint 

func SetRpcEndpoint(e string, f RpcEndpoint)

Types

type Agent 

type Agent struct {
	IP string // ip as seen from outside

	// getfile callback
	GetFile GetFileFunc
	// contains filtered or unexported fields
}

func New added in v0.5.0 

func New() *Agent

New will just initialize a basic agent without any settings

func Self added in v0.5.0 

func Self() *Agent

Self returns the Agent instance returned by New() (or similar), and will wait if instance has not been instanciated yet. As such, Self() should not be used in func init(), but only in separate goroutines or after instance has been created.

func WithGetFile added in v0.5.0 

func WithGetFile(f GetFileFunc) *Agent

return a new agent using the provided GetFile method

func WithIssuer added in v0.5.0 

func WithIssuer(url string) *Agent

func (*Agent) AddService added in v0.5.0 

func (a *Agent) AddService(service string) chan net.Conn

func (*Agent) AllRPC added in v0.5.7 

func (a *Agent) AllRPC(ctx context.Context, endpoint string, data interface{}) ([]interface{}, error)

func (*Agent) AnyRpc added in v0.5.0 

func (a *Agent) AnyRpc(ctx context.Context, division string, endpoint string, data interface{}) error

func (*Agent) BroadcastPacket added in v0.5.12 

func (a *Agent) BroadcastPacket(ctx context.Context, pc uint16, data []byte) error

func (*Agent) BroadcastRpc added in v0.5.0 

func (a *Agent) BroadcastRpc(ctx context.Context, endpoint string, data interface{}) error

func (*Agent) CacheDir added in v0.6.9 

func (a *Agent) CacheDir() string

func (*Agent) Close added in v0.5.0 

func (a *Agent) Close()

func (*Agent) ConfigureTlsServer added in v0.5.0 

func (a *Agent) ConfigureTlsServer(cfg *tls.Config)

func (*Agent) Connect added in v0.5.0 

func (a *Agent) Connect(id string, service string) (net.Conn, error)

connect to given peer under specified protocol (if supported)

func (*Agent) CountPeers added in v0.6.8 

func (a *Agent) CountPeers() int

func (*Agent) DbGet added in v0.5.0 

func (a *Agent) DbGet(key string) ([]byte, error)

simple db get for program usage

func (*Agent) DbSet added in v0.5.0 

func (a *Agent) DbSet(key string, value []byte) error

simple db set for program usage

func (*Agent) DbWatch added in v0.5.0 

func (a *Agent) DbWatch(key string, cb func(string, []byte))

DbWatch will trigger the cb function upon updates of the given key Special key "*" covers all keys (can only be one callback for a key)

func (*Agent) Dial added in v0.5.0 

func (a *Agent) Dial(network, addr string) (net.Conn, error)

func (*Agent) DialContext added in v0.5.0 

func (a *Agent) DialContext(c context.Context, network, addr string) (net.Conn, error)

func (*Agent) DivisionPrefixRpc added in v0.5.0 

func (a *Agent) DivisionPrefixRpc(ctx context.Context, divMatch string, endpoint string, data interface{}) error

func (*Agent) DivisionRpc added in v0.5.0 

func (a *Agent) DivisionRpc(ctx context.Context, division int, endpoint string, data interface{}) error

func (*Agent) DumpInfo added in v0.5.0 

func (a *Agent) DumpInfo(w io.Writer)

func (*Agent) GenInternalCert added in v0.5.0 

func (a *Agent) GenInternalCert() (tls.Certificate, error)

func (*Agent) GetCA added in v0.5.0 

func (a *Agent) GetCA() (*x509.CertPool, error)

func (*Agent) GetClientTlsConfig added in v0.5.0 

func (a *Agent) GetClientTlsConfig() (*tls.Config, error)

func (*Agent) GetDefaultPublicCert added in v0.5.0 

func (a *Agent) GetDefaultPublicCert() (tls.Certificate, error)

func (*Agent) GetInternalCert added in v0.5.0 

func (a *Agent) GetInternalCert() (tls.Certificate, error)

func (*Agent) GetInternalTlsConfig added in v0.5.11 

func (a *Agent) GetInternalTlsConfig() (*tls.Config, error)

func (*Agent) GetPeer added in v0.5.0 

func (a *Agent) GetPeer(id string) *Peer

func (*Agent) GetPeerByName added in v0.5.0 

func (a *Agent) GetPeerByName(name string) *Peer

func (*Agent) GetPeers added in v0.5.0 

func (a *Agent) GetPeers() []*Peer

func (*Agent) GetTlsConfig added in v0.5.0 

func (a *Agent) GetTlsConfig() (*tls.Config, error)

GetTlsConfig returns TLS config suitable for making public facing ssl servers.

func (*Agent) Id added in v0.5.0 

func (a *Agent) Id() string

func (*Agent) IsConnected added in v0.5.0 

func (a *Agent) IsConnected(id string) bool

func (*Agent) KeyShake128 added in v0.5.4 

func (a *Agent) KeyShake128(N []byte) (sha3.ShakeHash, error)

KeyShake128 uses PKCS8 private key blob as hash key

func (*Agent) KeyShake256 added in v0.5.4 

func (a *Agent) KeyShake256(N []byte) (sha3.ShakeHash, error)

KeySha256 uses PKCS8 private key blob as hash key

func (*Agent) LogDmesg added in v0.5.0 

func (a *Agent) LogDmesg(w io.Writer) (int64, error)

func (*Agent) LogTarget added in v0.5.0 

func (a *Agent) LogTarget() io.Writer

func (*Agent) MetaSet added in v0.6.10 

func (a *Agent) MetaSet(key string, value interface{})

func (*Agent) Name added in v0.5.0 

func (a *Agent) Name() (string, string)

func (*Agent) NewDbCursor added in v0.5.0 

func (a *Agent) NewDbCursor(bucket []byte) (*DbCursor, error)

func (*Agent) RPC added in v0.5.0 

func (a *Agent) RPC(ctx context.Context, id string, endpoint string, data interface{}) (interface{}, error)

func (*Agent) RoundTripper added in v0.5.0 

func (a *Agent) RoundTripper() http.RoundTripper

func (*Agent) SeedCrypt added in v0.5.0 

func (a *Agent) SeedCrypt(in []byte) ([]byte, error)

func (*Agent) SeedDecrypt added in v0.5.0 

func (a *Agent) SeedDecrypt(in []byte) ([]byte, error)

func (*Agent) SeedId added in v0.5.0 

func (a *Agent) SeedId() uuid.UUID

func (*Agent) SeedShake128 added in v0.5.4 

func (a *Agent) SeedShake128(N []byte) sha3.ShakeHash

func (*Agent) SeedShake256 added in v0.5.4 

func (a *Agent) SeedShake256(N []byte) sha3.ShakeHash

func (*Agent) SeedSign added in v0.5.0 

func (a *Agent) SeedSign(in []byte) []byte

func (*Agent) SeedTlsConfig added in v0.5.0 

func (a *Agent) SeedTlsConfig(c *tls.Config)

func (*Agent) SendPacketTo added in v0.5.12 

func (a *Agent) SendPacketTo(ctx context.Context, target string, pc uint16, data []byte) error

func (*Agent) SendTo added in v0.5.0 

func (a *Agent) SendTo(ctx context.Context, target string, pkt interface{}) error

type CustomHandler added in v0.5.12 

type CustomHandler func(p *Peer, data []byte) error

type DbCursor 

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

func (*DbCursor) Close 

func (c *DbCursor) Close() error

func (*DbCursor) First 

func (c *DbCursor) First() ([]byte, []byte)

func (*DbCursor) Last 

func (c *DbCursor) Last() ([]byte, []byte)

func (*DbCursor) Next 

func (c *DbCursor) Next() ([]byte, []byte)

func (*DbCursor) Seek 

func (c *DbCursor) Seek(pfx []byte) ([]byte, []byte)

type DbStamp 

type DbStamp time.Time

a timestamp for db

func DbNow 

func DbNow() DbStamp

func DbZero 

func DbZero() DbStamp

func (DbStamp) After 

func (t DbStamp) After(t2 DbStamp) bool

func (DbStamp) Bytes added in v0.5.7 

func (t DbStamp) Bytes() []byte

func (*DbStamp) GobDecode 

func (t *DbStamp) GobDecode(data []byte) error

func (DbStamp) GobEncode 

func (t DbStamp) GobEncode() ([]byte, error)

func (DbStamp) MarshalBinary 

func (t DbStamp) MarshalBinary() ([]byte, error)

func (DbStamp) String 

func (t DbStamp) String() string

func (DbStamp) Unix 

func (t DbStamp) Unix() int64

func (DbStamp) UnixNano 

func (t DbStamp) UnixNano() int64

func (*DbStamp) UnmarshalBinary 

func (t *DbStamp) UnmarshalBinary(data []byte) error

type DbWatchCallback added in v0.3.16 

type DbWatchCallback func(string, []byte)

type GetFileFunc added in v0.5.0 

type GetFileFunc func(*Agent, string) ([]byte, error)

type Packet 

type Packet interface{}

type PacketAnnounce 

type PacketAnnounce struct {
	Id   string
	Now  time.Time
	Idx  uint64
	NumG uint32 // number of goroutines
	AZ   string
	Meta map[string]interface{}
}

type PacketDbRecord 

type PacketDbRecord struct {
	TargetId string
	SourceId string
	Stamp    DbStamp
	Bucket   []byte // typically "app"
	Key, Val []byte
}

type PacketDbRequest added in v0.3.14 

type PacketDbRequest struct {
	TargetId string
	SourceId string
	Bucket   []byte // typically "app"
	Key      []byte
}

PacketDbRequest requests a specific record, response will be a PacketDbRecord

type PacketDbVersions added in v0.3.14 

type PacketDbVersions struct {
	Info []*PacketDbVersionsEntry
}

PacketDbVersions signals what records are available in a peer, typically sent on connection established

type PacketDbVersionsEntry added in v0.3.14 

type PacketDbVersionsEntry struct {
	Stamp  DbStamp
	Bucket []byte // typically "app"
	Key    []byte
}

type PacketHandshake 

type PacketHandshake struct {
	Id       string
	Name     string
	Division string
	Now      time.Time

	Git   string
	Build string
}

type PacketRpc 

type PacketRpc struct {
	TargetId string
	SourceId string
	Endpoint string
	R        uintptr
	Data     interface{}
}

type PacketRpcResponse 

type PacketRpcResponse struct {
	TargetId string
	SourceId string
	R        uintptr
	Data     interface{}
	Error    string
	HasError bool
}

type PacketSeed 

type PacketSeed struct {
	Seed []byte
	Time time.Time
}

type Peer 

type Peer struct {
	Ping time.Duration
	// contains filtered or unexported fields
}

func (*Peer) Agent added in v0.5.12 

func (p *Peer) Agent() *Agent

Agent returns the Agent object associated with this peer

func (*Peer) Close added in v0.3.19 

func (p *Peer) Close(reason string) error

func (*Peer) Division added in v0.5.12 

func (p *Peer) Division() string

Division returns this peer's division string

func (*Peer) Id added in v0.5.12 

func (p *Peer) Id() string

Id returns the peer's internal ID, which is unique and can be used to send packets to this peer specifically in the future.

func (*Peer) Meta added in v0.6.10 

func (p *Peer) Meta() map[string]interface{}

func (*Peer) Name added in v0.5.12 

func (p *Peer) Name() string

Name returns this peer's name

func (*Peer) Send 

func (p *Peer) Send(ctx context.Context, pkt Packet) error

func (*Peer) WritePacket added in v0.5.7 

func (p *Peer) WritePacket(ctx context.Context, pc uint16, data []byte) error

type RpcEndpoint 

type RpcEndpoint func(interface{}) (interface{}, error)

type ServiceConn 

type ServiceConn struct {
	net.Conn
}

embed connection in a separate object to avoid confusing go's HTTP server (among other stuff)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.