internalapi

Documentation

Index

• Variables
• func GetServerAddrForGuild(guildID int64) string
• func GetServerAddrForShard(shard int) string
• func GetWithAddress(addr string, url string, dest interface{}) error
• func GetWithGuild(guildID int64, url string, dest interface{}) error
• func GetWithShard(shard int, url string, dest interface{}) error
• func PostWithAddress(serverAddr string, url string, bodyData interface{}, dest interface{}) error
• func PostWithGuild(guildID int64, url string, bodyData interface{}, dest interface{}) error
• func PostWithShard(shard int, url string, bodyData interface{}, dest interface{}) error
• func RegisterPlugin()
• func ServeJson(w http.ResponseWriter, r *http.Request, data interface{})
• func ServerError(w http.ResponseWriter, r *http.Request, err error) bool
• type InternalAPIPlugin
• type Plugin
  • func (p *Plugin) CommonRun()
  • func (p *Plugin) PluginInfo() *common.PluginInfo

Variables

var (
	ErrServerError     = errors.New("internal api server is having issues")
	ErrCantFindAddress = errors.New("can't find address for provided shard")
)

var (
	ConfListenPortRange = config.RegisterOption("yagpdb.botrest.port_range", "botrest listen port range", "5100-5999")
)

Functions

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 GetWithGuild

func GetWithGuild(guildID int64, url string, dest interface{}) error

func GetWithShard

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

func PostWithAddress

func PostWithAddress(serverAddr string, url string, bodyData interface{}, dest interface{}) error

func PostWithGuild

func PostWithGuild(guildID int64, url string, bodyData interface{}, dest interface{}) error

func PostWithShard

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

func RegisterPlugin

func RegisterPlugin()

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 InternalAPIPlugin

type InternalAPIPlugin interface {
	InitInternalAPIRoutes(mux *goji.Mux)
}

InternalAPIPlugin represents a plugin that provides interactions with the internal apis

type Plugin

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

func (*Plugin) CommonRun

func (p *Plugin) CommonRun()

func (*Plugin) PluginInfo

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