[Spice-devel] [PATCH] SPICE port draft implementation

Pavel Grunt pgrunt at redhat.com
Wed Sep 14 11:40:51 UTC 2016


Hi Oliver,

On Mon, 2016-09-12 at 10:46 +0200, Oliver Gutierrez wrote:
> ---
>  enums.js        |  11 ++++-
>  main.js         |   7 +++-
>  port.js         | 125
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  spice.html      |   1 +
>  spice_auto.html |   3 +-
>  5 files changed, 143 insertions(+), 4 deletions(-)
>  create mode 100644 port.js
> 
> diff --git a/enums.js b/enums.js
> index 3ef36dc..b6e013c 100644
> --- a/enums.js
> +++ b/enums.js
> @@ -166,6 +166,15 @@ var SPICE_MSG_PLAYBACK_VOLUME           = 105;
>  var SPICE_MSG_PLAYBACK_MUTE             = 106;
>  var SPICE_MSG_PLAYBACK_LATENCY          = 107;
>  
> +var SPICE_MSG_SPICEVMC_DATA             = 101;
> +var SPICE_MSG_PORT_INIT                 = 201;
> +var SPICE_MSG_PORT_EVENT                = 202;
> +var SPICE_MSG_END_PORT                  = 203;
> +
> +var SPICE_MSGC_SPICEVMC_DATA            = 101;
> +var SPICE_MSGC_PORT_EVENT               = 201;
> +var SPICE_MSGC_END_PORT                 = 202;
> +
>  var SPICE_PLAYBACK_CAP_CELT_0_5_1       = 0;
>  var SPICE_PLAYBACK_CAP_VOLUME           = 1;
>  var SPICE_PLAYBACK_CAP_LATENCY          = 2;
> @@ -264,7 +273,7 @@ var SPICE_MOUSE_BUTTON_MASK_LEFT = (1 << 0),
>      SPICE_MOUSE_BUTTON_MASK_MIDDLE = (1 << 1),
>      SPICE_MOUSE_BUTTON_MASK_RIGHT = (1 << 2),
>      SPICE_MOUSE_BUTTON_MASK_MASK = 0x7;
> -    
> +
>  var SPICE_MOUSE_BUTTON_INVALID  = 0;
>  var SPICE_MOUSE_BUTTON_LEFT     = 1;
>  var SPICE_MOUSE_BUTTON_MIDDLE   = 2;
> diff --git a/main.js b/main.js
> index afe69bf..ba5a737 100644
> --- a/main.js
> +++ b/main.js
> @@ -22,7 +22,7 @@
>  **  SpiceMainConn
>  **      This is the master Javascript class for establishing and
>  **  managing a connection to a Spice Server.
> -**  
> +**
>  **      Invocation:  You must pass an object with properties as
> follows:
>  **          uri         (required)  Uri of a WebSocket listener
> that is
>  **                                  connected to a spice server.
> @@ -59,6 +59,7 @@ function SpiceMainConn()
>      this.file_xfer_tasks = {};
>      this.file_xfer_task_id = 0;
>      this.file_xfer_read_queue = [];
> +    this.ports = [];
>  }
>  
>  SpiceMainConn.prototype = Object.create(SpiceConn.prototype);
> @@ -153,7 +154,9 @@ SpiceMainConn.prototype.process_channel_message
> = function(msg)
>              else if (chans.channels[i].type ==
> SPICE_CHANNEL_CURSOR)
>                  this.cursor = new SpiceCursorConn(conn);
>              else if (chans.channels[i].type ==
> SPICE_CHANNEL_PLAYBACK)
> -                this.cursor = new SpicePlaybackConn(conn);
> +                this.playback = new SpicePlaybackConn(conn);
this deserves a separate commit ^
> +            else if (chans.channels[i].type == SPICE_CHANNEL_PORT)
> +                this.ports.push(new SpicePortConn(conn));
>              else
>              {
>                  if (! ("extra_channels" in this))
> diff --git a/port.js b/port.js
> new file mode 100644
> index 0000000..2c96724
> --- /dev/null
> +++ b/port.js
> @@ -0,0 +1,125 @@
> +"use strict";
> +/*
> +   Copyright (C) 2016 by Oliver Gutierrez <ogutsua at gmail.com>
> +
> +   This file is part of spice-html5.
> +
> +   spice-html5 is free software: you can redistribute it and/or
> modify
> +   it under the terms of the GNU Lesser General Public License as
> published by
> +   the Free Software Foundation, either version 3 of the License,
> or
> +   (at your option) any later version.
> +
> +   spice-html5 is distributed in the hope that it will be useful,
> +   but WITHOUT ANY WARRANTY; without even the implied warranty of
> +   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +   GNU Lesser General Public License for more details.
> +
> +   You should have received a copy of the GNU Lesser General Public
> License
> +   along with spice-html5.  If not, see <http://www.gnu.org/license
> s/>.
> +*/
> +
> +/*-----------------------------------------------------------------
> -----------
> +**  SpiceCursorConn
> +**      Drive the Spice Cursor Channel

Description should be for the Port Channel

> +**-----------------------------------------------------------------
> ---------*/
> +function SpicePortConn()
> +{
> +    DEBUG > 0 && console.log(
> +      'SPICE port: created SPICE port channel. Args:', arguments);

no need for the line break (more places)

> +
> +    SpiceConn.apply(this, arguments);
> +    this.port_name = null;
> +}
> +
> +SpicePortConn.prototype = Object.create(SpiceConn.prototype);
> +
> +SpicePortConn.prototype.process_channel_message = function(msg)
> +{
> +  if (msg.type == SPICE_MSG_PORT_INIT)
> +  {
indentation is 4 spaces (more places)
> +    if (this.port_name === null) {
brackets on extra line (more places)
> +      var m = new SpiceMsgPortInit(msg.data);
> +      this.portName = new TextDecoder('utf-8').decode(new
> Uint8Array(m.name));
> +      this.portOpened = m.opened
> +
> +      DEBUG > 0 && console.log(
> +        'SPICE port: Port', this.portName, 'initialized');

no need for the line break

> +
> +      return true;
> +    }
> +
> +    DEBUG > 0 && console.log(
> +      'SPICE port: Port', this.port_name, 'is already
> initialized.');

no need for the line break

> +  else if (msg.type == SPICE_MSG_PORT_EVENT)
> +  {
> +    DEBUG > 0 && console.log(
> +      'SPICE port: Port event received for', this.portName, msg);
> +
> +    var event = new CustomEvent("spice-port-event", {
> +			detail: {
> +        channel: this,
> +				spiceEvent: new
> Uint8Array(msg.data)
> +			},
> +			bubbles: true,
> +			cancelable: true
> +		});
> +
> +    window.dispatchEvent(event);
> +    return true;
> +  }
> +  else if (msg.type == SPICE_MSG_SPICEVMC_DATA)
> +  {
> +    DEBUG > 0 && console.log(
> +      'SPICE port: Data received in port', this.portName, msg);
> +
> +    var event = new CustomEvent("spice-port-data", {
> +			detail: {
> +        channel: this,
> +				data: msg.data
> +			},
> +			bubbles: true,
> +			cancelable: true
> +		});
> +
> +    window.dispatchEvent(event);
> +    return true;
> +  }
> +  else
> +  {
> +    DEBUG > 0 && console.log(
> +      'SPICE port: SPICE message type not recognized:', msg)
> +  }
> +
> +  return false;
> +};
> +
> +function SpiceMsgPortInit(a, at)
> +{
> +    this.from_buffer(a,at);
> +};
> +
> +SpiceMsgPortInit.prototype =
> +{
> +    from_buffer: function (a, at)
> +    {
> +      at = at || 0;
> +      var dv = new SpiceDataView(a);
> +      var namesize = dv.getUint32(at, true); at += 4;
> +      var offset = dv.getUint32(at, true); at += 4;
> +      this.opened = dv.getUint8(at, true); at += 1;
> +      this.name = a.slice(offset, offset + namesize - 1);
> +    }
> +}

as you said these messages should be moved 

> +
> +window.addEventListener('spice-port-data', function(event) {
> +  var msg_text = new TextDecoder('utf-8').decode(
> +    new Uint8Array(event.detail.data));
> +  console.log(
> +    'SPICE port', event.detail.channel.portName, 'message text:',
> msg_text)
> +})
> +
> +window.addEventListener('spice-port-event', function(event) {
> +  console.log(
> +    'SPICE port', event.detail.channel.portName, 'event data:',
> event.detail.spiceEvent)
> +})

these are just an usage examples, right ? 

> diff --git a/spice.html b/spice.html
> index f2f9ed0..0de2763 100644
> --- a/spice.html
> +++ b/spice.html
> @@ -42,6 +42,7 @@
>          <script src="wire.js"></script> 
>          <script src="spiceconn.js"></script> 
>          <script src="display.js"></script> 
> +        <script src="port.js"></script> 
>          <script src="main.js"></script> 
>          <script src="inputs.js"></script> 
>          <script src="webm.js"></script>
> diff --git a/spice_auto.html b/spice_auto.html
> index 9aae118..f04a10e 100644
> --- a/spice_auto.html
> +++ b/spice_auto.html
> @@ -28,7 +28,7 @@
>      <head>
>  
>          <title>Spice Javascript client</title>
> -        <script src="spicearraybuffer.js"></script> 
> +        <script src="spicearraybuffer.js"></script>
>          <script src="enums.js"></script>
>          <script src="atKeynames.js"></script>
>          <script src="utils.js"></script>
> @@ -42,6 +42,7 @@
>          <script src="wire.js"></script>
>          <script src="spiceconn.js"></script>
>          <script src="display.js"></script>
> +        <script src="port.js"></script> 
>          <script src="main.js"></script>
>          <script src="inputs.js"></script>
>          <script src="webm.js"></script>
> 

Besides the indentation, brackets it looks good to me

Thanks,
Pavel





More information about the Spice-devel mailing list