dojox/cometd/longPollTransportFormEncoded.js

  • Provides:

    • dojox.cometd.longPollTransportFormEncoded
  • Requires:

    • dojox.cometd._base in common
  • dojox.cometd.longPollTransportFormEncoded

    • type
      Function
    • ?? initialized = 1 (debug: boolean) ??
    • source: [view]
      dojo.provide("dojox.cometd.longPollTransportFormEncoded");
      dojo.require("dojox.cometd._base");


      dojox.cometd.longPollTransportFormEncoded = new function(){
       // This is an alternative implementation to that provided in logPollTransport.js that
       // form encodes all messages instead of sending them as text/json

       
       this._connectionType = "long-polling";
       this._cometd = null;


       this.check = function(types, version, xdomain){
        return ((!xdomain)&&(dojo.indexOf(types, "long-polling") >= 0));
       }


       this.tunnelInit = function(){
        var message = {
         channel: "/meta/connect",
         clientId: this._cometd.clientId,
         connectionType: this._connectionType,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        this.openTunnelWith({ message: dojo.toJson([message]) });
       }


       this.tunnelCollapse = function(){
        // TODO handle transport specific advice

        
        if(!this._cometd._initialized){ return; }
        if(this._cometd._advice && this._cometd._advice["reconnect"]=="none"){
         return;
        }
        var interval = this._cometd._interval();
        if (this._cometd._status=="connected") {
         setTimeout(dojo.hitch(this, "_connect"), interval);
        }else{
         setTimeout(dojo.hitch(this._cometd, function(){
          this.init(this.url, this._props);
         }), interval);
        }
       }


       this._connect = function(){
        if(!this._cometd._initialized){ return; }
        if(this._cometd._polling) { return; }

         
        if((this._cometd._advice) && (this._cometd._advice["reconnect"]=="handshake")){
         this._cometd._status="unconnected"; //?
         this._initialized = false;
         this._cometd.init(this._cometd.url, this._cometd._props);
        }else if(this._cometd._status=="connected"){
         var message = {
          channel: "/meta/connect",
          connectionType: this._connectionType,
          clientId: this._cometd.clientId,
          id: "" + this._cometd.messageId++
         };
         if(this._cometd.connectTimeout>=this._cometd.expectedNetworkDelay){
          message.advice = {
           timeout: this._cometd.connectTimeout - this._cometd.expectedNetworkDelay
          };
         }
         message = this._cometd._extendOut(message);
         this.openTunnelWith({ message: dojo.toJson([message]) });
        }
       }


       this.deliver = function(message){
        // Nothing to do
       }


       this.openTunnelWith = function(content, url){
        this._cometd._polling = true;
        var post = {
         url: (url||this._cometd.url),
         content: content,
         handleAs: this._cometd.handleAs,
         load: dojo.hitch(this, function(data){
          this._cometd._polling=false;
          this._cometd.deliver(data);
          this._cometd._backon();
          this.tunnelCollapse();
         }),
         error: dojo.hitch(this, function(err){
          var metaMsg = {
           failure: true,
           error: err,
           advice: this._cometd._advice
          };
          this._cometd._polling=false;
          this._cometd._publishMeta("connect",false, metaMsg);
          this._cometd._backoff();
          this.tunnelCollapse();
         })
        };


        var connectTimeout = this._cometd._connectTimeout();
        if(connectTimeout > 0){
         post.timeout = connectTimeout;
        }


        this._poll = dojo.xhrPost(post);
       }


       this.sendMessages = function(messages){
        for(var i=0; i < messages.length; i++){
         messages[i].clientId = this._cometd.clientId;
         messages[i].id = "" + this._cometd.messageId++;
         messages[i]= this._cometd._extendOut(messages[i]);
        }
        return dojo.xhrPost({
         url: this._cometd.url||dojo.config["cometdRoot"],
         handleAs: this._cometd.handleAs,
         load: dojo.hitch(this._cometd, "deliver"),
         content: { message: dojo.toJson(messages) },
         error: dojo.hitch(this, function(err){
          this._cometd._publishMeta("publish",false,{messages:messages});
         }),
         timeout: this._cometd.expectedNetworkDelay
        });
       }


       this.startup = function(handshakeData){
        if(this._cometd._status=="connected"){ return; }
        this.tunnelInit();
       }


       this.disconnect = function(){
        var message = {
         channel: "/meta/disconnect",
         clientId: this._cometd.clientId,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        dojo.xhrPost({
         url: this._cometd.url || dojo.config["cometdRoot"],
         handleAs: this._cometd.handleAs,
         content: { message: dojo.toJson([message]) }
        });
       }


       this.cancelConnect = function(){
        if(this._poll){
         this._poll.cancel();
         this._cometd._polling=false;
         this._cometd._publishMeta("connect",false,{cancel:true});
         this._cometd._backoff();
         this.disconnect();
         this.tunnelCollapse();
        }
       }
    • summary
  • dojox.cometd.longPollTransportFormEncoded._connectionType

    • summary
  • dojox.cometd.longPollTransportFormEncoded._cometd

    • summary
  • dojox.cometd.longPollTransportFormEncoded.check

    • type
      Function
    • parameters:
      • types: (typeof )
      • version: (typeof )
      • xdomain: (typeof )
    • source: [view]
        return ((!xdomain)&&(dojo.indexOf(types, "long-polling") >= 0));
    • summary
  • dojox.cometd.longPollTransportFormEncoded.tunnelInit

    • type
      Function
    • source: [view]
        var message = {
         channel: "/meta/connect",
         clientId: this._cometd.clientId,
         connectionType: this._connectionType,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        this.openTunnelWith({ message: dojo.toJson([message]) });
    • summary
  • dojox.cometd.longPollTransportFormEncoded.tunnelCollapse

    • type
      Function
    • source: [view]
      dojo.provide("dojox.cometd.longPollTransportFormEncoded");
      dojo.require("dojox.cometd._base");


      dojox.cometd.longPollTransportFormEncoded = new function(){
       // This is an alternative implementation to that provided in logPollTransport.js that
       // form encodes all messages instead of sending them as text/json

       
       this._connectionType = "long-polling";
       this._cometd = null;


       this.check = function(types, version, xdomain){
        return ((!xdomain)&&(dojo.indexOf(types, "long-polling") >= 0));
       }


       this.tunnelInit = function(){
        var message = {
         channel: "/meta/connect",
         clientId: this._cometd.clientId,
         connectionType: this._connectionType,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        this.openTunnelWith({ message: dojo.toJson([message]) });
       }


       this.tunnelCollapse = function(){
        // TODO handle transport specific advice

        
        if(!this._cometd._initialized){ return; }
        if(this._cometd._advice && this._cometd._advice["reconnect"]=="none"){
         return;
        }
        var interval = this._cometd._interval();
        if (this._cometd._status=="connected") {
         setTimeout(dojo.hitch(this, "_connect"), interval);
        }else{
         setTimeout(dojo.hitch(this._cometd, function(){
          this.init(this.url, this._props);
         }), interval);
        }
    • summary
  • dojox.cometd.longPollTransportFormEncoded._cometd._status

    • summary
  • dojox.cometd.longPollTransportFormEncoded._connect

    • type
      Function
    • source: [view]
        if(!this._cometd._initialized){ return; }
        if(this._cometd._polling) { return; }

         
        if((this._cometd._advice) && (this._cometd._advice["reconnect"]=="handshake")){
         this._cometd._status="unconnected"; //?
         this._initialized = false;
         this._cometd.init(this._cometd.url, this._cometd._props);
        }else if(this._cometd._status=="connected"){
         var message = {
          channel: "/meta/connect",
          connectionType: this._connectionType,
          clientId: this._cometd.clientId,
          id: "" + this._cometd.messageId++
         };
         if(this._cometd.connectTimeout>=this._cometd.expectedNetworkDelay){
          message.advice = {
           timeout: this._cometd.connectTimeout - this._cometd.expectedNetworkDelay
          };
         }
         message = this._cometd._extendOut(message);
         this.openTunnelWith({ message: dojo.toJson([message]) });
        }
    • summary
  • dojox.cometd.longPollTransportFormEncoded._initialized

    • summary
  • dojox.cometd.longPollTransportFormEncoded.deliver

    • type
      Function
    • parameters:
      • message: (typeof )
    • source: [view]
      dojo.provide("dojox.cometd.longPollTransportFormEncoded");
      dojo.require("dojox.cometd._base");


      dojox.cometd.longPollTransportFormEncoded = new function(){
       // This is an alternative implementation to that provided in logPollTransport.js that
       // form encodes all messages instead of sending them as text/json

       
       this._connectionType = "long-polling";
       this._cometd = null;


       this.check = function(types, version, xdomain){
        return ((!xdomain)&&(dojo.indexOf(types, "long-polling") >= 0));
       }


       this.tunnelInit = function(){
        var message = {
         channel: "/meta/connect",
         clientId: this._cometd.clientId,
         connectionType: this._connectionType,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        this.openTunnelWith({ message: dojo.toJson([message]) });
       }


       this.tunnelCollapse = function(){
        // TODO handle transport specific advice

        
        if(!this._cometd._initialized){ return; }
        if(this._cometd._advice && this._cometd._advice["reconnect"]=="none"){
         return;
        }
        var interval = this._cometd._interval();
        if (this._cometd._status=="connected") {
         setTimeout(dojo.hitch(this, "_connect"), interval);
        }else{
         setTimeout(dojo.hitch(this._cometd, function(){
          this.init(this.url, this._props);
         }), interval);
        }
       }


       this._connect = function(){
        if(!this._cometd._initialized){ return; }
        if(this._cometd._polling) { return; }

         
        if((this._cometd._advice) && (this._cometd._advice["reconnect"]=="handshake")){
         this._cometd._status="unconnected"; //?
         this._initialized = false;
         this._cometd.init(this._cometd.url, this._cometd._props);
        }else if(this._cometd._status=="connected"){
         var message = {
          channel: "/meta/connect",
          connectionType: this._connectionType,
          clientId: this._cometd.clientId,
          id: "" + this._cometd.messageId++
         };
         if(this._cometd.connectTimeout>=this._cometd.expectedNetworkDelay){
          message.advice = {
           timeout: this._cometd.connectTimeout - this._cometd.expectedNetworkDelay
          };
         }
         message = this._cometd._extendOut(message);
         this.openTunnelWith({ message: dojo.toJson([message]) });
        }
       }


       this.deliver = function(message){
        // Nothing to do
    • summary
  • dojox.cometd.longPollTransportFormEncoded.openTunnelWith

    • type
      Function
    • parameters:
      • content: (typeof )
      • url: (typeof )
    • source: [view]
        this._cometd._polling = true;
        var post = {
         url: (url||this._cometd.url),
         content: content,
         handleAs: this._cometd.handleAs,
         load: dojo.hitch(this, function(data){
          this._cometd._polling=false;
          this._cometd.deliver(data);
          this._cometd._backon();
          this.tunnelCollapse();
         }),
         error: dojo.hitch(this, function(err){
          var metaMsg = {
           failure: true,
           error: err,
           advice: this._cometd._advice
          };
          this._cometd._polling=false;
          this._cometd._publishMeta("connect",false, metaMsg);
          this._cometd._backoff();
          this.tunnelCollapse();
         })
        };


        var connectTimeout = this._cometd._connectTimeout();
        if(connectTimeout > 0){
         post.timeout = connectTimeout;
        }


        this._poll = dojo.xhrPost(post);
    • summary
  • dojox.cometd.longPollTransportFormEncoded._cometd._polling

    • summary
  • dojox.cometd.longPollTransportFormEncoded._poll

    • summary
  • dojox.cometd.longPollTransportFormEncoded.sendMessages

    • type
      Function
    • parameters:
      • messages: (typeof )
    • source: [view]
        for(var i=0; i < messages.length; i++){
         messages[i].clientId = this._cometd.clientId;
         messages[i].id = "" + this._cometd.messageId++;
         messages[i]= this._cometd._extendOut(messages[i]);
        }
        return dojo.xhrPost({
         url: this._cometd.url||dojo.config["cometdRoot"],
         handleAs: this._cometd.handleAs,
         load: dojo.hitch(this._cometd, "deliver"),
         content: { message: dojo.toJson(messages) },
         error: dojo.hitch(this, function(err){
          this._cometd._publishMeta("publish",false,{messages:messages});
         }),
         timeout: this._cometd.expectedNetworkDelay
        });
    • summary
  • dojox.cometd.longPollTransportFormEncoded.startup

    • type
      Function
    • parameters:
      • handshakeData: (typeof )
    • source: [view]
        if(this._cometd._status=="connected"){ return; }
        this.tunnelInit();
    • summary
  • dojox.cometd.longPollTransportFormEncoded.disconnect

    • type
      Function
    • source: [view]
        var message = {
         channel: "/meta/disconnect",
         clientId: this._cometd.clientId,
         id: "" + this._cometd.messageId++
        };
        message = this._cometd._extendOut(message);
        dojo.xhrPost({
         url: this._cometd.url || dojo.config["cometdRoot"],
         handleAs: this._cometd.handleAs,
         content: { message: dojo.toJson([message]) }
        });
    • summary
  • dojox.cometd.longPollTransportFormEncoded.cancelConnect

    • type
      Function
    • source: [view]
        if(this._poll){
         this._poll.cancel();
         this._cometd._polling=false;
         this._cometd._publishMeta("connect",false,{cancel:true});
         this._cometd._backoff();
         this.disconnect();
         this.tunnelCollapse();
        }
    • summary
  • dojox.cometd.longPollTransport

    • summary
  • dojox.cometd

    • type
      Object
    • summary
  • dojox

    • type
      Object
    • summary