api

package

v0.0.0-...-804f56e Latest Latest Go to latest Published: Dec 10, 2018 License: Zlib Imports: 15 Imported by: 0

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/fabiocolacio/quicksilver

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Login(user, passwd string) ([]byte, error)
func LookupUser(user string) error
func MessageSend(jwt []byte, peer, message string) error
func Register(user, passwd string) error
func SetHost(newHost string)
func UnwrapJWT(jwt []byte) (server.Session, error)
type Message
- func MessageFetch(jwt []byte, peer, since string) ([]Message, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrLoginFailed = errors.New("Login failed.")
	ErrNoSuchUser  = errors.New("No such user.")
)

View Source

var (
	ErrMalformedJWT = errors.New("Malformed JWT")
)

Functions ¶

func Login(user, passwd string) ([]byte, error)

Login attempts to login to the Mercury Server. If it is successful, it returns the JWT.

func LookupUser ¶

func LookupUser(user string) error

LookupUser checks if a user exists in Mercury's database

func MessageSend ¶

func MessageSend(jwt []byte, peer, message string) error

MessageSend sends message to peer using the Mercrury server

func Register ¶

func Register(user, passwd string) error

Register registers a user with the Mercury server

func SetHost ¶

func SetHost(newHost string)

SetHost changes the host server that will be used by Quicksilver

func UnwrapJWT ¶

func UnwrapJWT(jwt []byte) (server.Session, error)

UnwrapJWT returns the JSON payload element of a JWT

Types ¶

type Message ¶

type Message struct {
	Username  string
	Timestamp string
	Message   crypto.EncryptedMessage
}

Message represents Mercury's internal representation of a message

func MessageFetch ¶

func MessageFetch(jwt []byte, peer, since string) ([]Message, error)

MessageFetch checks for messages from peer through the Mercury Server

Source Files ¶

View all Source files

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