storage

Documentation

Index

• func CountOfflineMessages(username string) (int, error)
• func DeleteBlockListItems(items []model.BlockListItem) error
• func DeleteOfflineMessages(username string) error
• func DeleteRosterItem(username, jid string) (rostermodel.Version, error)
• func DeleteRosterNotification(contact, jid string) error
• func DeleteUser(username string) error
• func FetchBlockListItems(username string) ([]model.BlockListItem, error)
• func FetchOfflineMessages(username string) ([]*xmpp.Message, error)
• func FetchPrivateXML(namespace string, username string) ([]xmpp.XElement, error)
• func FetchRosterItem(username, jid string) (*rostermodel.Item, error)
• func FetchRosterItems(username string) ([]rostermodel.Item, rostermodel.Version, error)
• func FetchRosterNotification(contact string, jid string) (*rostermodel.Notification, error)
• func FetchRosterNotifications(contact string) ([]rostermodel.Notification, error)
• func FetchUser(username string) (*model.User, error)
• func FetchVCard(username string) (xmpp.XElement, error)
• func InsertBlockListItems(items []model.BlockListItem) error
• func InsertOfflineMessage(message *xmpp.Message, username string) error
• func InsertOrUpdatePrivateXML(privateXML []xmpp.XElement, namespace string, username string) error
• func InsertOrUpdateRosterItem(ri *rostermodel.Item) (rostermodel.Version, error)
• func InsertOrUpdateRosterNotification(rn *rostermodel.Notification) error
• func InsertOrUpdateUser(user *model.User) error
• func InsertOrUpdateVCard(vCard xmpp.XElement, username string) error
• func Set(storage Storage)
• func Unset()
• func UserExists(username string) (bool, error)
• type Config
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Storage
  • func New(config *Config) (Storage, error)
• type StorageType

Functions

func CountOfflineMessages

func CountOfflineMessages(username string) (int, error)

CountOfflineMessages returns current length of user's offline queue.

func DeleteBlockListItems

func DeleteBlockListItems(items []model.BlockListItem) error

DeleteBlockListItems deletes a set of block list item entities from storage.

func DeleteOfflineMessages

func DeleteOfflineMessages(username string) error

DeleteOfflineMessages clears a user offline queue.

func DeleteRosterItem

func DeleteRosterItem(username, jid string) (rostermodel.Version, error)

DeleteRosterItem deletes a roster item entity from storage.

func DeleteRosterNotification

func DeleteRosterNotification(contact, jid string) error

DeleteRosterNotification deletes a roster notification entity from storage.

func DeleteUser

func DeleteUser(username string) error

DeleteUser deletes a user entity from storage.

func FetchBlockListItems

func FetchBlockListItems(username string) ([]model.BlockListItem, error)

FetchBlockListItems retrieves from storage all block list item entities associated to a given user.

func FetchOfflineMessages

func FetchOfflineMessages(username string) ([]*xmpp.Message, error)

FetchOfflineMessages retrieves from storage current user offline queue.

func FetchPrivateXML

func FetchPrivateXML(namespace string, username string) ([]xmpp.XElement, error)

FetchPrivateXML retrieves from storage a private element.

func FetchRosterItem

func FetchRosterItem(username, jid string) (*rostermodel.Item, error)

FetchRosterItem retrieves from storage a roster item entity.

func FetchRosterItems

func FetchRosterItems(username string) ([]rostermodel.Item, rostermodel.Version, error)

FetchRosterItems retrieves from storage all roster item entities associated to a given user.

func FetchRosterNotification

func FetchRosterNotification(contact string, jid string) (*rostermodel.Notification, error)

FetchRosterNotification retrieves from storage a roster notification entity.

func FetchRosterNotifications

func FetchRosterNotifications(contact string) ([]rostermodel.Notification, error)

FetchRosterNotifications retrieves from storage all roster notifications associated to a given user.

func FetchUser

func FetchUser(username string) (*model.User, error)

FetchUser retrieves from storage a user entity.

func FetchVCard

func FetchVCard(username string) (xmpp.XElement, error)

FetchVCard retrieves from storage a vCard element associated to a given user.

func InsertBlockListItems

func InsertBlockListItems(items []model.BlockListItem) error

InsertBlockListItems inserts a set of block list item entities into storage, only in case they haven't been previously inserted.

func InsertOfflineMessage

func InsertOfflineMessage(message *xmpp.Message, username string) error

InsertOfflineMessage inserts a new message element into user's offline queue.

func InsertOrUpdatePrivateXML

func InsertOrUpdatePrivateXML(privateXML []xmpp.XElement, namespace string, username string) error

InsertOrUpdatePrivateXML inserts a new private element into storage, or updates it in case it's been previously inserted.

func InsertOrUpdateRosterItem

func InsertOrUpdateRosterItem(ri *rostermodel.Item) (rostermodel.Version, error)

InsertOrUpdateRosterItem inserts a new roster item entity into storage, or updates it in case it's been previously inserted.

func InsertOrUpdateRosterNotification

func InsertOrUpdateRosterNotification(rn *rostermodel.Notification) error

InsertOrUpdateRosterNotification inserts a new roster notification entity into storage, or updates it in case it's been previously inserted.

func InsertOrUpdateUser

func InsertOrUpdateUser(user *model.User) error

InsertOrUpdateUser inserts a new user entity into storage, or updates it in case it's been previously inserted.

func InsertOrUpdateVCard

func InsertOrUpdateVCard(vCard xmpp.XElement, username string) error

InsertOrUpdateVCard inserts a new vCard element into storage, or updates it in case it's been previously inserted.

func Set

func Set(storage Storage)

func Unset

func Unset()

func UserExists

func UserExists(username string) (bool, error)

UserExists returns whether or not a user exists within storage.

Types

type Config

type Config struct {
	Type     StorageType
	MySQL    *sql.Config
	BadgerDB *badgerdb.Config
}

Config represents an storage manager configuration.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML satisfies Unmarshaler interface.

type Storage

type Storage interface {
	io.Closer
	// contains filtered or unexported methods
}

Storage represents an entity storage interface.

var Disabled Storage = &disabledStorage{}

func New

func New(config *Config) (Storage, error)

Initialize initializes storage sub system.

type StorageType

type StorageType int

StorageType represents a storage manager type.

const (
	// MySQL represents a MySQL storage type.
	MySQL StorageType = iota

	// BadgerDB represents a BadgerDB storage type.
	BadgerDB

	// Memory represents a in-memstorage storage type.
	Memory
)