chemicalweb / gcm

Google Cloud Messaging for application servers implemented using the Go programming language.

gcm

The Android SDK provides a nice convenience library (com.google.android.gcm.server) that greatly simplifies the interaction between Java-based application servers and Google's GCM servers. However, Google has not provided much support for application servers implemented in languages other than Java, specifically those written in the Go programming language. The gcm package helps to fill in this gap, providing a simple interface for sending GCM messages and automatically retrying requests in case of service unavailability.

Documentation: http://godoc.org/github.com/alexjlockwood/gcm

Getting Started

To install gcm, use go get:

go get github.com/alexjlockwood/gcm

Import gcm with the following:

import "github.com/alexjlockwood/gcm"

Sample Usage

Here is a quick sample illustrating how to send a message to the GCM server:

package sample

import (
    "fmt"
    "net/http"
    "github.com/alexjlockwood/gcm"
)

func main() {
    // Create the message to be sent
    regIds := []string{"4","8","15","16","23","42"}
    data := map[string]string{"score": "5x1", "time": "15:10"}
    msg := gcm.NewMessage(data, regIds...)

    // Create a Sender to send the message
    sender := &gcm.NewSender("sample_api_key")
    
    // Send the message and receive the response after at most two retries.
    response, err := sender.Send(msg, 2)
    if err != nil {
        fmt.Println("Failed to send message: " + err.Error())
        return       
    }
}

Note for Google AppEngine users

If your application server runs on Google AppEngine, you must import the appengine/urlfetch package and create the Sender as follows:

import (
    "appengine"
    "appengine/urlfetch"
    "github.com/alexjlockwood/gcm"
)

func handler(w http.ResponseWriter, r *http.Request) {
    /* ... */

    c := appengine.NewContext(r)
    client := urlfetch.Client(c)
    sender := gcm.NewSender("sample_api_key", client)

    /* ... */
}