@qooxdoo/framework/source/class/qx/io/transport/ITransport.js

The JS Framework for Coders

/**
 * The interface for all transports located in this namespace
 */
qx.Interface.define("qx.io.transport.ITransport", {
  properties: {
    /**
     * The URI of the endpoint
     * @var {String}
     */
    endpoint: {
      event: "changeEndpoint"
    }
  },

  events: {
    /**
     * Event fired when a message is received from the endpoint. Event data
     * is an UTF-8 encoded string
     */
    message: "qx.event.type.Data"
  },

  members: {
    /**
     * Transport the given message to the endpoint
     *
     * @param {String} message
     * @return {qx.Promise} Promise that resolves (with no data)
     * when the message has been successfully sent out, and rejects
     * when there is an error or a cancellation up to that point.
     */
    async send(message) {},

    /**
     * Returns the object which implements the transport on the underlying
     * level, so that transport-specific configuration can be done on it.
     * The object might be a new one for each request.
     * @return {Object}
     */
    getTransportImpl() {}
  }
});