api

package

v0.0.0-...-8027ee6 Latest Latest Go to latest Published: May 7, 2023 License: MIT Imports: 13 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/code-to-go/safepool

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ChatPrivates(poolName string) ([]chat.Private, error)
func ChatReceive(poolName string, after, before time.Time, limit int, private chat.Private) ([]chat.Message, error)
func ChatSend(poolName string, contentType string, text string, bytes []byte, ...) (uint64, error)
func Dump() map[string]any
func FactoryReset() error
func InviteReceive(poolName string, after int64, onlyMine bool) ([]invite.Invite, error)
func LibraryFind(poolName string, id uint64) (library.File, error)
func LibraryList(poolName string, folder string) (library.List, error)
func LibraryReceive(poolName string, id uint64, localPath string) error
func LibrarySave(poolName string, id uint64, dest string) error
func LibrarySend(poolName string, localPath string, name string, solveConflicts bool, ...) (library.File, error)
func PoolCreate(c pool.Config, apps []string) error
func PoolGet(name string) (*pool.Pool, error)
func PoolInvite(name string, ids []string, invitePool string) (string, error)
func PoolJoin(token string) (pool.Config, error)
func PoolLeave(name string) error
func PoolParseInvite(token string) (invite.Invite, error)
func PoolSub(name string, sub string, ids []string, apps []string) (string, error)
func PoolUsers(poolName string) ([]security.Identity, error)
func SetDbName(dbName string)
func SetDbPath(dbPath string)
func SetSelf(identity security.Identity) error
func Start(dbPath string, availableBandwith pool.Bandwidth) error
func Stop() error
type Notification
- func Notifications(ctime int64) []Notification

Constants ¶

This section is empty.

Variables ¶

View Source

var Apps = []string{
	"chat",
	"library",
}

View Source

var Self security.Identity

Functions ¶

func ChatPrivates ¶

func ChatPrivates(poolName string) ([]chat.Private, error)

func ChatReceive ¶

func ChatReceive(poolName string, after, before time.Time, limit int, private chat.Private) ([]chat.Message, error)

func ChatSend ¶

func ChatSend(poolName string, contentType string, text string, bytes []byte, private chat.Private) (uint64, error)

func Dump ¶

func Dump() map[string]any

func FactoryReset ¶

func FactoryReset() error

FactoryReset deletes and recreates the DB. It is useful during development to recover from inconsistent data and structure.

func InviteReceive ¶

func InviteReceive(poolName string, after int64, onlyMine bool) ([]invite.Invite, error)

func LibraryFind ¶

func LibraryFind(poolName string, id uint64) (library.File, error)

func LibraryList ¶

func LibraryList(poolName string, folder string) (library.List, error)

func LibraryReceive ¶

func LibraryReceive(poolName string, id uint64, localPath string) error

func LibrarySave ¶

func LibrarySave(poolName string, id uint64, dest string) error

func LibrarySend ¶

func LibrarySend(poolName string, localPath string, name string, solveConflicts bool, tags ...string) (library.File, error)

func PoolCreate ¶

func PoolCreate(c pool.Config, apps []string) error

func PoolGet ¶

func PoolGet(name string) (*pool.Pool, error)

func PoolInvite ¶

func PoolInvite(name string, ids []string, invitePool string) (string, error)

func PoolJoin ¶

func PoolJoin(token string) (pool.Config, error)

PoolJoin adds a pool by using the provided invite token

func PoolLeave ¶

func PoolLeave(name string) error

func PoolParseInvite ¶

func PoolParseInvite(token string) (invite.Invite, error)

PoolParseInvite checks the validity of the provided invite token and returns the token object

func PoolSub ¶

func PoolSub(name string, sub string, ids []string, apps []string) (string, error)

func PoolUsers ¶

func PoolUsers(poolName string) ([]security.Identity, error)

func SetDbName ¶

func SetDbName(dbName string)

SetDbName set the name of the DB file. Useful for test purpose

func SetDbPath ¶

func SetDbPath(dbPath string)

SetDbPath set the full path where the DB will be created. Useful on Android/iOS platforms

func SetSelf ¶

func SetSelf(identity security.Identity) error

func Start ¶

func Start(dbPath string, availableBandwith pool.Bandwidth) error

Start initializes the library using the provided dbPath and availableBandwidth. It creates a new db when dbPath is not an existing file.

func Stop ¶

func Stop() error

Stop closes the DB and it releases all connected pools

Types ¶

type Notification ¶

type Notification struct {
	Pool    string `json:"pool"`
	App     string `json:"app"`
	Message string `json:"message"`
	Count   int    `json:"count"`
}

func Notifications ¶

func Notifications(ctime int64) []Notification

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL