gaurun

Documentation

Index

• Constants
• Variables
• func ApnsPushHttp2(token string, service *push.Service, headers *push.Headers, ...) error
• func ConfigHandler(w http.ResponseWriter, r *http.Request)
• func InitHttpClient() error
• func InitLog() *logrus.Logger
• func InitStat()
• func LogAcceptedRequest(uri, method, proto string, length int64)
• func LogPush(id uint64, status, token string, ptime float64, req RequestGaurunNotification, ...)
• func NewApnsClientHttp2(certPath, keyPath string) (*http.Client, error)
• func NewApnsHeadersHttp2(req *RequestGaurunNotification) *push.Headers
• func NewApnsPayloadHttp2(req *RequestGaurunNotification) map[string]interface{}
• func NewApnsServiceHttp2(client *http.Client) *push.Service
• func NewTransportHttp2(cert tls.Certificate) (*http.Transport, error)
• func PrintVersion()
• func PushNotificationHandler(w http.ResponseWriter, r *http.Request)
• func RegisterHTTPHandlers()
• func RunHTTPServer()
• func SetLogLevel(log *logrus.Logger, levelString string) error
• func SetLogOut(log *logrus.Logger, outString string) error
• func StartPushWorkers(workerNum, queueNum int)
• func StatsHandler(w http.ResponseWriter, r *http.Request)
• type CertificatePem
• type ConfToml
  • func BuildDefaultConf() ConfToml
  • func LoadConf(confGaurun ConfToml, confPath string) (ConfToml, error)
• type ExtendJSON
• type GaurunFormatter
  • func (f *GaurunFormatter) Format(entry *logrus.Entry) ([]byte, error)
• type LogPushEntry
• type LogReq
• type RequestGaurun
• type RequestGaurunNotification
• type ResponseGaurun
• type SectionAndroid
• type SectionApi
• type SectionCore
• type SectionIos
• type SectionLog
• type StatAndroid
• type StatApp
• type StatIos

Constants

const (
	PlatFormIos = iota + 1
	PlatFormAndroid
)

const (
	StatusAcceptedPush  = "accepted-push"
	StatusSucceededPush = "succeeded-push"
	StatusFailedPush    = "failed-push"
)

const (
	Version = "0.6.0"
)

Variables

var (
	ConfGaurun        ConfToml
	QueueNotification chan RequestGaurunNotification
	CertificatePemIos CertificatePem
	LogAccess         *logrus.Logger
	LogError          *logrus.Logger
	StatGaurun        StatApp
	// for numbering push
	OnceNumbering sync.Once
	WgNumbering   *sync.WaitGroup
	SeqID         uint64
	GCMClient     *gcm.Sender
	APNSClient    *http.Client
)

var (
	PusherCount int64
)

Functions

func ApnsPushHttp2

func ApnsPushHttp2(token string, service *push.Service, headers *push.Headers, payload map[string]interface{}) error

func ConfigHandler

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

func InitHttpClient

func InitHttpClient() error

func InitLog

func InitLog() *logrus.Logger

func InitStat

func InitStat()

func LogAcceptedRequest

func LogAcceptedRequest(uri, method, proto string, length int64)

func LogPush

func LogPush(id uint64, status, token string, ptime float64, req RequestGaurunNotification, errPush error)

func NewApnsClientHttp2

func NewApnsClientHttp2(certPath, keyPath string) (*http.Client, error)

func NewApnsHeadersHttp2

func NewApnsHeadersHttp2(req *RequestGaurunNotification) *push.Headers

func NewApnsPayloadHttp2

func NewApnsPayloadHttp2(req *RequestGaurunNotification) map[string]interface{}

func NewApnsServiceHttp2

func NewApnsServiceHttp2(client *http.Client) *push.Service

func NewTransportHttp2

func NewTransportHttp2(cert tls.Certificate) (*http.Transport, error)

func PrintVersion

func PrintVersion()

func PushNotificationHandler

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

func RegisterHTTPHandlers

func RegisterHTTPHandlers()

func RunHTTPServer

func RunHTTPServer()

func SetLogLevel

func SetLogLevel(log *logrus.Logger, levelString string) error

func SetLogOut

func SetLogOut(log *logrus.Logger, outString string) error

func StartPushWorkers

func StartPushWorkers(workerNum, queueNum int)

func StatsHandler

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

Types

type CertificatePem

type CertificatePem struct {
	Cert []byte
	Key  []byte
}

type ConfToml

type ConfToml struct {
	Core    SectionCore    `toml:"core"`
	Api     SectionApi     `toml:"api"`
	Android SectionAndroid `toml:"android"`
	Ios     SectionIos     `toml:"ios"`
	Log     SectionLog     `toml:"log"`
}

func BuildDefaultConf

func BuildDefaultConf() ConfToml

func LoadConf

func LoadConf(confGaurun ConfToml, confPath string) (ConfToml, error)

type ExtendJSON

type ExtendJSON struct {
	Key   string `json:"key"`
	Value string `json:"val"`
}

type GaurunFormatter

type GaurunFormatter struct {
}

func (*GaurunFormatter) Format

func (f *GaurunFormatter) Format(entry *logrus.Entry) ([]byte, error)

type LogPushEntry

type LogPushEntry struct {
	Type     string  `json:"type"`
	Time     string  `json:"time"`
	ID       uint64  `json:"id"`
	Platform string  `json:"platform"`
	Token    string  `json:"token"`
	Message  string  `json:"message"`
	Ptime    float64 `json:"ptime"`
	Error    string  `json:"error"`
	// Android
	CollapseKey    string `json:"collapse_key,omitempty"`
	DelayWhileIdle bool   `json:"delay_while_idle,omitempty"`
	TimeToLive     int    `json:"time_to_live,omitempty"`
	// iOS
	Badge            int    `json:"badge,omitempty"`
	Sound            string `json:"sound,omitempty"`
	ContentAvailable bool   `json:"content_available,omitempty"`
	Expiry           int    `json:"expiry,omitempty"`
}

type LogReq

type LogReq struct {
	Type          string `json:"type"`
	Time          string `json:"time"`
	URI           string `json:"uri"`
	Method        string `json:"method"`
	Proto         string `json:"proto"`
	ContentLength int64  `json:"content_length"`
}

type RequestGaurun

type RequestGaurun struct {
	Notifications []RequestGaurunNotification `json:"notifications"`
}

type RequestGaurunNotification

type RequestGaurunNotification struct {
	// Common
	Tokens   []string `json:"token"`
	Platform int      `json:"platform"`
	Message  string   `json:"message"`
	// Android
	CollapseKey    string `json:"collapse_key,omitempty"`
	DelayWhileIdle bool   `json:"delay_while_idle,omitempty"`
	TimeToLive     int    `json:"time_to_live,omitempty"`
	// iOS
	Badge            int          `json:"badge,omitempty"`
	Sound            string       `json:"sound,omitempty"`
	ContentAvailable bool         `json:"content_available,omitempty"`
	Expiry           int          `json:"expiry,omitempty"`
	Retry            int          `json:"retry,omitempty"`
	Extend           []ExtendJSON `json:"extend,omitempty"`
	// meta
	ID uint64 `json:"seq_id,omitempty"`
}

type ResponseGaurun

type ResponseGaurun struct {
	Message string `json:"message"`
}

type SectionAndroid

type SectionAndroid struct {
	Enabled          bool   `toml:"enabled"`
	ApiKey           string `toml:"apikey"`
	Timeout          int    `toml:"timeout"`
	KeepAliveTimeout int    `toml:"keepalive_timeout"`
	KeepAliveConns   int    `toml:"keepalive_conns"`
	RetryMax         int    `toml:"retry_max"`
}

type SectionApi

type SectionApi struct {
	PushUri      string `toml:"push_uri"`
	StatGoUri    string `toml:"stat_go_uri"`
	StatAppUri   string `toml:"stat_app_uri"`
	ConfigAppUri string `toml:"config_app_uri"`
}

type SectionCore

type SectionCore struct {
	Port            string `toml:"port"`
	WorkerNum       int    `toml:"workers"`
	QueueNum        int    `toml:"queues"`
	NotificationMax int    `toml:"notification_max"`
	PusherMax       int64  `toml:"pusher_max"`
}

type SectionIos

type SectionIos struct {
	Enabled          bool   `toml:"enabled"`
	PemCertPath      string `toml:"pem_cert_path"`
	PemKeyPath       string `toml:"pem_key_path"`
	Sandbox          bool   `toml:"sandbox"`
	RetryMax         int    `toml:"retry_max"`
	Timeout          int    `toml:"timeout"`
	KeepAliveTimeout int    `toml:"keepalive_timeout"`
	KeepAliveConns   int    `toml:"keepalive_conns"`
	Topic            string `toml:"topic"`
}

type SectionLog

type SectionLog struct {
	AccessLog string `toml:"access_log"`
	ErrorLog  string `toml:"error_log"`
	Level     string `toml:"level"`
}

type StatAndroid

type StatAndroid struct {
	PushSuccess int64 `json:"push_success"`
	PushError   int64 `json:"push_error"`
}

type StatApp

type StatApp struct {
	QueueMax    int         `json:"queue_max"`
	QueueUsage  int         `json:"queue_usage"`
	PusherMax   int64       `json:"pusher_max"`
	PusherCount int64       `json:"pusher_count"`
	Ios         StatIos     `json:"ios"`
	Android     StatAndroid `json:"android"`
}

type StatIos

type StatIos struct {
	PushSuccess int64 `json:"push_success"`
	PushError   int64 `json:"push_error"`
}