English

Google App Engine

The channel package

Introduction

The channel package implements the server side of App Engine's Channel API.

Create creates a new channel associated with the given clientID, which must be unique to the client that will use the returned token.

token, err := channel.Create(c, "player1")
if err != nil {
    // handle error
}
// return token to the client in an HTTP response

Send sends a message to the client over the channel identified by clientID.

channel.Send(c, "player1", "Game over!")

Functions

func Create

func Create(c appengine.Context, clientID string) (token string, err os.Error)

Create creates a channel and returns a token for use by the client. The clientID is an appication-provided string used to identify the client.

func Send

func Send(c appengine.Context, clientID, message string) os.Error

Send sends a message on the channel associated with clientID.

func SendJSON

func SendJSON(c appengine.Context, clientID string, value interface{}) os.Error

SendJSON is a helper function that sends a JSON-encoded value on the channel associated with clientID.