botrest

README

Provides access to bot state using a rest api to be accessed from e.g scripts or the webserver

Documentation

Index

• Variables
• func BotIsRunning() bool
• func Get(shard int, url string, dest interface{}) error
• func GetBotMember(guildID int64) (m *discordgo.Member, err error)
• func GetChannelPermissions(guildID, channelID int64) (perms int64, err error)
• func GetGuild(guildID int64) (g *discordgo.Guild, err error)
• func GetMemberColors(guildID int64, members ...int64) (m map[string]int, err error)
• func GetMemberMultiGuild(userID int64, guilds ...int64) (members []*discordgo.Member, err error)
• func GetMembers(guildID int64, members ...int64) (m []*discordgo.Member, err error)
• func GetOnlineCount(guildID int64) (c int64, err error)
• func GetServerAddrForGuild(guildID int64) string
• func GetServerAddrForShard(shard int) string
• func GetWithAddress(addr string, url string, dest interface{}) error
• func HandleBotMember(w http.ResponseWriter, r *http.Request)
• func HandleChannelPermissions(w http.ResponseWriter, r *http.Request)
• func HandleGWStatus(w http.ResponseWriter, r *http.Request)
• func HandleGetMemberColors(w http.ResponseWriter, r *http.Request)
• func HandleGetMembers(w http.ResponseWriter, r *http.Request)
• func HandleGetOnlineCount(w http.ResponseWriter, r *http.Request)
• func HandleGuild(w http.ResponseWriter, r *http.Request)
• func HandlePing(w http.ResponseWriter, r *http.Request)
• func HandleReconnectShard(w http.ResponseWriter, r *http.Request)
• func Post(shard int, url string, bodyData interface{}, dest interface{}) error
• func RedisKeyNodeAddressMapping(nodeID string) string
• func RedisKeyShardAddressMapping(shardID int) string
• func RegisterPlugin()
• func RestartAll(reidentify bool)
• func RunPinger()
• func SendReconnectAll(reidentify bool) (err error)
• func SendReconnectShard(shardID int, reidentify bool) (err error)
• func ServeJson(w http.ResponseWriter, r *http.Request, data interface{})
• func ServerError(w http.ResponseWriter, r *http.Request, err error) bool
• type BotRestPlugin
• type NodeStatus
  • func GetNodeStatuses() (st []*NodeStatus, err error)
• type Plugin
  • func (p *Plugin) BotInit()
  • func (p *Plugin) PluginInfo() *common.PluginInfo
  • func (p *Plugin) StopBot(wg *sync.WaitGroup)
• type ShardStatus

Variables

var (
	ErrServerError    = errors.New("botrest server is having issues")
	ErrCantFindServer = errors.New("can't find botrest server for provided shard")
)

Functions

func BotIsRunning

func BotIsRunning() bool

Returns wether the bot is running or not, (time since last sucessfull ping was less than 5 seconds)

func Get

func Get(shard int, url string, dest interface{}) error

func GetBotMember

func GetBotMember(guildID int64) (m *discordgo.Member, err error)

func GetChannelPermissions

func GetChannelPermissions(guildID, channelID int64) (perms int64, err error)

func GetGuild

func GetGuild(guildID int64) (g *discordgo.Guild, err error)

func GetMemberColors

func GetMemberColors(guildID int64, members ...int64) (m map[string]int, err error)

func GetMemberMultiGuild

func GetMemberMultiGuild(userID int64, guilds ...int64) (members []*discordgo.Member, err error)

func GetMembers

func GetMembers(guildID int64, members ...int64) (m []*discordgo.Member, err error)

func GetOnlineCount

func GetOnlineCount(guildID int64) (c int64, err error)

func GetServerAddrForGuild

func GetServerAddrForGuild(guildID int64) string

func GetServerAddrForShard

func GetServerAddrForShard(shard int) string

func GetWithAddress

func GetWithAddress(addr string, url string, dest interface{}) error

func HandleBotMember

func HandleBotMember(w http.ResponseWriter, r *http.Request)

func HandleChannelPermissions

func HandleChannelPermissions(w http.ResponseWriter, r *http.Request)

func HandleGWStatus

func HandleGWStatus(w http.ResponseWriter, r *http.Request)

func HandleGetMemberColors

func HandleGetMemberColors(w http.ResponseWriter, r *http.Request)

func HandleGetMembers

func HandleGetMembers(w http.ResponseWriter, r *http.Request)

func HandleGetOnlineCount

func HandleGetOnlineCount(w http.ResponseWriter, r *http.Request)

func HandleGuild

func HandleGuild(w http.ResponseWriter, r *http.Request)

func HandlePing

func HandlePing(w http.ResponseWriter, r *http.Request)

func HandleReconnectShard

func HandleReconnectShard(w http.ResponseWriter, r *http.Request)

func Post

func Post(shard int, url string, bodyData interface{}, dest interface{}) error

func RedisKeyNodeAddressMapping

func RedisKeyNodeAddressMapping(nodeID string) string

func RedisKeyShardAddressMapping

func RedisKeyShardAddressMapping(shardID int) string

func RegisterPlugin

func RegisterPlugin()

func RestartAll

func RestartAll(reidentify bool)

func RunPinger

func RunPinger()

func SendReconnectAll

func SendReconnectAll(reidentify bool) (err error)

func SendReconnectShard

func SendReconnectShard(shardID int, reidentify bool) (err error)

func ServeJson

func ServeJson(w http.ResponseWriter, r *http.Request, data interface{})

func ServerError

func ServerError(w http.ResponseWriter, r *http.Request, err error) bool

Returns true if an error occured

Types

type BotRestPlugin

type BotRestPlugin interface {
	InitBotRestServer(mux *goji.Mux)
}

type NodeStatus

type NodeStatus struct {
	ID     string
	Shards []*ShardStatus `json:"shards"`
}

func GetNodeStatuses

func GetNodeStatuses() (st []*NodeStatus, err error)

type Plugin

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

func (*Plugin) BotInit

func (p *Plugin) BotInit()

func (*Plugin) PluginInfo

func (p *Plugin) PluginInfo() *common.PluginInfo

func (*Plugin) StopBot

func (p *Plugin) StopBot(wg *sync.WaitGroup)

type ShardStatus

type ShardStatus struct {
	ShardID         int     `json:"shard_id"`
	TotalEvents     int64   `json:"total_events"`
	EventsPerSecond float64 `json:"events_per_second"`

	ConnStatus discordgo.GatewayStatus `json:"conn_status"`

	LastHeartbeatSend time.Time `json:"last_heartbeat_send"`
	LastHeartbeatAck  time.Time `json:"last_heartbeat_ack"`
}