1. module gcm
   1. function gcm.GCM (apiKey)
   2. object gcm.GCM.prototype
2. module gcm.GCM
   1. function gcm.GCM (apiKey)
   2. function gcm.GCM.super_ ()
3. module gcm.GCM.prototype
   1. function gcm.GCM.prototype.send (packet, cb)

module gcm

function gcm.GCM (apiKey)

• description and source-code

  function GCM(apiKey) {
      if (apiKey) {
          this.apiKey = apiKey;
      } else {
          throw Error('No apiKey is given.');
      }
      this.gcmOptions = {
          host: 'android.googleapis.com',
          port: 443,
          path: '/gcm/send',
          method: 'POST',
          headers: {}
      };
  }

• example usage

  n/a

module gcm.GCM

function gcm.GCM (apiKey)

• description and source-code

  function GCM(apiKey) {
      if (apiKey) {
          this.apiKey = apiKey;
      } else {
          throw Error('No apiKey is given.');
      }
      this.gcmOptions = {
          host: 'android.googleapis.com',
          port: 443,
          path: '/gcm/send',
          method: 'POST',
          headers: {}
      };
  }

• example usage

  n/a

function gcm.GCM.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module gcm.GCM.prototype

function gcm.GCM.prototype.send (packet, cb)

• description and source-code

  send = function (packet, cb) {
      var self = this;
      if (cb) this.once('sent', cb);
  
      var operation = retry.operation();
  
      operation.attempt(function(currentAttempt) {
          var postData = querystring.stringify(packet);
          var headers = {
              'Host': self.gcmOptions.host,
              'Authorization': 'key=' + self.apiKey,
              'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
              'Content-length': postData.length
          };
          self.gcmOptions.headers = headers;
          if (self.keepAlive)
              headers.Connection = 'keep-alive';
  
          var request = https.request(self.gcmOptions, function(res) {
              var data = '';
  
              if (res.statusCode == 503) {
                  // If the server is temporary unavailable, the C2DM spec requires that we implement exponential backoff
                  // and respect any Retry-After header
                  if (res.headers['retry-after']) {
                      var retrySeconds = res.headers['retry-after'] * 1; // force number
                      if (isNaN(retrySeconds)) {
                          // The Retry-After header is a HTTP-date, try to parse it
                          retrySeconds = new Date(res.headers['retry-after']).getTime() - new Date().getTime();
                      }
                      if (!isNaN(retrySeconds) && retrySeconds > 0) {
                          operation._timeouts['minTimeout'] = retrySeconds;
                      }
                  }
                  if (!operation.retry('TemporaryUnavailable')) {
                      self.emit('sent', operation.mainError(), null);
                  }
                  // Ignore all subsequent events for this request
                  return;
              }
  
              function respond() {
                  var error = null, id = null;
  
                  if (data.indexOf('Error=') === 0) {
                      error = data.substring(6).trim();
                  }
                  else if (data.indexOf('id=') === 0) {
                      id = data.substring(3).trim();
                  }
                  else {
                      // No id nor error?
                      error = 'InvalidServerResponse';
                  }
  
                  // Only retry if error is QuotaExceeded or DeviceQuotaExceeded
                  if (operation.retry(['QuotaExceeded', 'DeviceQuotaExceeded', 'InvalidServerResponse'].indexOf(error) >= 0 ? error
   : null)) {
                      return;
                  }
  
                  // Success, return message id (without id=)
                  self.emit('sent', error, id);
              }
  
              res.on('data', function(chunk) {
                  data += chunk;
              });
              res.on('end', respond);
              res.on('close', respond);
          });
          request.on('error', function(error) {
              self.emit('sent', error, null);
          });
          request.end(postData);
      });
  }

• example usage

  ...
  var message = {
      registration_id: 'Device registration id', // required
      collapse_key: 'Collapse key',
      'data.key1': 'value1',
      'data.key2': 'value2'
  };
  
  gcm.send(message, function(err, messageId){
      if (err) {
          console.log("Something has gone wrong!");
      } else {
          console.log("Sent with message ID: ", messageId);
      }
  });
  ...