interfaces

Documentation

Index

• type APNSPushQueue
• type DB
• type FeedbackReporter
• type GCMClient
• type InvalidTokenHandler
• type KafkaConsumerClient
• type KafkaMessage
• type KafkaProducerClient
• type MessageHandler
• type Queue
• type StatsDClient
• type StatsReporter

Types

type APNSPushQueue

type APNSPushQueue interface {
	ResponseChannel() chan *structs.ResponseWithMetadata
	Configure() error
	Push(*apns2.Notification)
	Close()
}

APNSPushQueue represents the contract for a APNS Push Queue.

type DB

type DB interface {
	Exec(interface{}, ...interface{}) (*types.Result, error)
	ExecOne(interface{}, ...interface{}) (*types.Result, error)
	Query(interface{}, interface{}, ...interface{}) (*types.Result, error)
	Close() error
}

DB represents the contract for a Postgres DB.

type FeedbackReporter

type FeedbackReporter interface {
	SendFeedback(game string, platform string, feedback []byte)
}

FeedbackReporter interface for making new feedback reporters pluggable easily.

type GCMClient

type GCMClient interface {
	SendXMPP(gcm.XMPPMessage) (string, int, error)
	Close() error
}

GCMClient represents the contract for a GCM Client.

type InvalidTokenHandler

type InvalidTokenHandler interface {
	HandleToken(token string, game string, platform string) error
}

InvalidTokenHandler interface for defining functions that handle invalid tokens easily pluggable.

type KafkaConsumerClient

type KafkaConsumerClient interface {
	SubscribeTopics([]string, kafka.RebalanceCb) error
	Events() chan kafka.Event
	Assign([]kafka.TopicPartition) error
	Unassign() error
	Close() error
}

KafkaConsumerClient interface.

type KafkaMessage

type KafkaMessage struct {
	Game  string
	Topic string
	Value []byte
}

KafkaMessage sent through the Channel.

type KafkaProducerClient

type KafkaProducerClient interface {
	Events() chan kafka.Event
	ProduceChannel() chan *kafka.Message
}

KafkaProducerClient interface.

type MessageHandler

type MessageHandler interface {
	HandleMessages(msg KafkaMessage)
	HandleResponses()
	LogStats()
	CleanMetadataCache()
}

MessageHandler interface for making message handlers pluggable easily.

type Queue

type Queue interface {
	MessagesChannel() *chan KafkaMessage
	ConsumeLoop() error
	StopConsuming()
	PendingMessagesWaitGroup() *sync.WaitGroup
}

Queue interface for making new queues pluggable easily.

type StatsDClient

type StatsDClient interface {
	Incr(string, []string, float64) error
	Gauge(string, float64, []string, float64) error
	Count(string, int64, []string, float64) error
	Timing(string, time.Duration, []string, float64) error
	Close() error
}

StatsDClient interface.

type StatsReporter

type StatsReporter interface {
	InitializeFailure(game string, platform string)
	HandleNotificationSent(game string, platform string)
	HandleNotificationSuccess(game string, platform string)
	HandleNotificationFailure(game string, platform string, err *errors.PushError)
	ReportGoStats(numGoRoutines int, allocatedAndNotFreed, heapObjects, nextGCBytes, pauseGCNano uint64)
	ReportMetricGauge(metric string, value float64, game string, platform string)
	ReportMetricCount(metric string, value int64, game string, platform string)
}

StatsReporter interface for making stats reporters pluggable easily.