summaryrefslogtreecommitdiffstats
path: root/infrastructure/framework-src/modules/comet.js
diff options
context:
space:
mode:
authorAlexander Sulfrian <alexander@sulfrian.net>2010-06-08 09:01:43 +0200
committerAlexander Sulfrian <alexander@sulfrian.net>2010-06-08 09:01:43 +0200
commitd1fa08fdc9cb11dccee76d668ff85df30458c295 (patch)
tree1d19df6405103577d872902486792e8c23bce711 /infrastructure/framework-src/modules/comet.js
parentd7c5ad7d6263fd1baf9bfdbaa4c50b70ef2fbdb2 (diff)
parent70d1f9d6fcaefe611e778b8dbf3bafea8934aa08 (diff)
downloadetherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.tar.gz
etherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.tar.bz2
etherpad-d1fa08fdc9cb11dccee76d668ff85df30458c295.zip
Merge remote branch 'upstream/master'
Conflicts: etherpad/src/etherpad/control/pro/admin/pro_admin_control.js etherpad/src/etherpad/control/pro/pro_main_control.js etherpad/src/etherpad/control/pro_help_control.js etherpad/src/etherpad/globals.js etherpad/src/etherpad/legacy_urls.js etherpad/src/etherpad/pne/pne_utils.js etherpad/src/etherpad/pro/pro_utils.js etherpad/src/main.js etherpad/src/plugins/fileUpload/templates/fileUpload.ejs etherpad/src/plugins/testplugin/templates/page.ejs etherpad/src/static/css/pad2_ejs.css etherpad/src/static/css/pro-help.css etherpad/src/static/img/jun09/pad/protop.gif etherpad/src/static/js/store.js etherpad/src/themes/default/templates/framed/framedheader-pro.ejs etherpad/src/themes/default/templates/main/home.ejs etherpad/src/themes/default/templates/pro-help/main.ejs etherpad/src/themes/default/templates/pro-help/pro-help-template.ejs infrastructure/com.etherpad/licensing.scala trunk/etherpad/src/etherpad/collab/ace/contentcollector.js trunk/etherpad/src/etherpad/collab/ace/linestylefilter.js trunk/etherpad/src/static/css/home-opensource.css trunk/etherpad/src/static/js/ace.js trunk/etherpad/src/static/js/linestylefilter_client.js trunk/etherpad/src/templates/email/eepnet_license_info.ejs trunk/etherpad/src/templates/pad/pad_body2.ejs trunk/etherpad/src/templates/pad/pad_content.ejs trunk/etherpad/src/templates/pad/padfull_body.ejs trunk/etherpad/src/templates/pro/admin/pne-license-manager.ejs
Diffstat (limited to 'infrastructure/framework-src/modules/comet.js')
-rw-r--r--infrastructure/framework-src/modules/comet.js91
1 files changed, 91 insertions, 0 deletions
diff --git a/infrastructure/framework-src/modules/comet.js b/infrastructure/framework-src/modules/comet.js
new file mode 100644
index 0000000..2331f8b
--- /dev/null
+++ b/infrastructure/framework-src/modules/comet.js
@@ -0,0 +1,91 @@
+/**
+ * Copyright 2009 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @fileOverview
+ * Comet presents a real-time bidirectional-channel interface. Using comet, your
+ * server can push data to any connected client without waiting for that client
+ * to issue a request.
+ *
+ * <tt>comet</tt> reserves the <tt>/newcomet</tt> path and its subpaths for its
+ * own use.
+ */
+
+/**
+ * Gets a list of all client currently connected to the server.
+ * @function
+ * @name connections
+ * @return {array} An array of the string ids of all connected clients.
+ */
+function connections() {
+ return Packages.net.appjet.ajstdlib.Comet.connections(appjet.context);
+}
+
+function getNumCurrentConnections() {
+ return Packages.net.appjet.ajstdlib.Comet.getNumCurrentConnections();
+}
+
+function isConnected(id) {
+ return Packages.net.appjet.ajstdlib.Comet.isConnected(id);
+}
+
+function disconnect(id) {
+ Packages.net.appjet.ajstdlib.Comet.disconnect(id);
+}
+
+function getAttribute(id, key) {
+ var ret = Packages.net.appjet.ajstdlib.Comet.getAttribute(appjet.context, id, key);
+ if (ret != null)
+ return String(ret);
+}
+
+function setAttribute(id, key, value) {
+ Packages.net.appjet.ajstdlib.Comet.setAttribute(appjet.context, id, key, value);
+}
+
+/**
+ * Sends a message to a particular client.
+ * @functionn
+ * @name sendMessage
+ * @param {string} id The <tt>id</tt> of the client to send to.
+ * @param {string} data The string data to send to the client.
+ */
+function sendMessage(id, msg) {
+ Packages.net.appjet.ajstdlib.Comet.write(id, msg);
+}
+
+function headInclude() { return '<script src="'+appjet.config.cometPrefix+'/js/client.js"></script>'; };
+function clientCode() {
+ return Packages.net.appjet.ajstdlib.Comet.getClientCode(appjet.context);
+};
+function clientMTime() {
+ return Packages.net.appjet.ajstdlib.Comet.getClientMTime(appjet.context);
+};
+
+/**
+ * WebSocket allows the client to connect to the server via a
+ * "bidirectional" channel. Messages sent by the server are received by
+ * the client without the need for additional connections or other delays.
+ * @class
+ * @name WebSocket
+ * @param {string} id The id to use for this client.
+ */
+
+/**
+ * Connects to the server using the id specified in the constructor.
+ * @methodOf WebSocket
+ * @name connect
+ */