doc/gug/protocol-reference.html

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Guacamole protocol reference — Apache Guacamole Manual v1.5.3</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/tabs.css" type="text/css" /> <link rel="stylesheet" href="_static/gug.css" type="text/css" />  <script src="_static/jquery.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script> <script src="_static/sphinx_highlight.js"></script> <script src="_static/tabs.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Writing your own Guacamole application" href="writing-you-own-guacamole-app.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> Apache Guacamole </a> <div class="version"> 1.5.3 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> Overview <ul> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li> </ul> User's Guide <ul> <li class="toctree-l1"><a class="reference internal" href="guacamole-architecture.html">Implementation and architecture</a></li> <li class="toctree-l1"><a class="reference internal" href="installing-guacamole.html">Installing Guacamole natively</a></li> <li class="toctree-l1"><a class="reference internal" href="guacamole-docker.html">Installing Guacamole with Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="reverse-proxy.html">Proxying Guacamole</a></li> <li class="toctree-l1"><a class="reference internal" href="configuring-guacamole.html">Configuring Guacamole</a></li> <li class="toctree-l1"><a class="reference internal" href="jdbc-auth.html">Database authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="ldap-auth.html">LDAP authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="vault.html">Retrieving secrets from a vault</a></li> <li class="toctree-l1"><a class="reference internal" href="duo-auth.html">Duo two-factor authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="totp-auth.html">TOTP two-factor authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="header-auth.html">HTTP header authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="json-auth.html">Encrypted JSON authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="cas-auth.html">CAS Authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="openid-auth.html">OpenID Connect Authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="saml-auth.html">SAML Authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="radius-auth.html">RADIUS Authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="adhoc-connections.html">Ad-hoc Connections</a></li> <li class="toctree-l1"><a class="reference internal" href="using-guacamole.html">Using Guacamole</a></li> <li class="toctree-l1"><a class="reference internal" href="recording-playback.html">Viewing session recordings in-browser</a></li> <li class="toctree-l1"><a class="reference internal" href="administration.html">Administration</a></li> <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li> </ul> Developer's Guide <ul> <li class="toctree-l1"><a class="reference internal" href="guacamole-protocol.html">The Guacamole protocol</a></li> <li class="toctree-l1"><a class="reference internal" href="libguac.html">libguac</a></li> <li class="toctree-l1"><a class="reference internal" href="guacamole-common.html">guacamole-common</a></li> <li class="toctree-l1"><a class="reference internal" href="guacamole-common-js.html">guacamole-common-js</a></li> <li class="toctree-l1"><a class="reference internal" href="guacamole-ext.html">guacamole-ext</a></li> <li class="toctree-l1"><a class="reference internal" href="custom-protocols.html">Adding new protocols</a></li> <li class="toctree-l1"><a class="reference internal" href="custom-auth.html">Custom authentication</a></li> <li class="toctree-l1"><a class="reference internal" href="event-listeners.html">Event listeners</a></li> <li class="toctree-l1"><a class="reference internal" href="writing-you-own-guacamole-app.html">Writing your own Guacamole application</a></li> </ul> Appendices <ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">Guacamole protocol reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="#drawing-instructions">Drawing instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#streaming-instructions">Streaming instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#object-instructions">Object instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#client-handshake-instructions">Client handshake instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#server-handshake-instructions">Server handshake instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#control-instructions">Control instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#server-control-instructions">Server control instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#input-event-instructions">Input/Event instructions</a></li> <li class="toctree-l2"><a class="reference internal" href="#status-codes">Status codes</a></li> <li class="toctree-l2"><a class="reference internal" href="#message-codes">Message Codes</a></li> </ul> </li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">Apache Guacamole</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Guacamole protocol reference</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/protocol-reference.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="guacamole-protocol-reference"> <h1>Guacamole protocol reference<a class="headerlink" href="#guacamole-protocol-reference" title="Permalink to this heading"></a></h1> <section id="drawing-instructions"> <h2>Drawing instructions<a class="headerlink" href="#drawing-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="arc-instruction"> arc<a class="headerlink" href="#arc-instruction" title="Permalink to this definition"></a></dt> <dd>The arc instruction adds the specified arc subpath to the existing path, creating a new path if no path exists. The path created can be modified further by other path-type instructions, and finally stroked, filled, and/or closed. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer which should have the specified arc subpath added.</li> <li>x (integer) – The X coordinate of the center of the circle containing the arc to be drawn.</li> <li>y (integer) – The Y coordinate of the center of the circle containing the arc to be drawn.</li> <li>radius (float) – The radius of the circle containing the arc to be drawn, in pixels.</li> <li>start (float) – The starting angle of the arc to be drawn, in radians.</li> <li>end (float) – The ending angle of the arc to be drawn, in radians.</li> <li>negative (integer) – Non-zero if the arc should be drawn from START to END in order of decreasing angle, zero otherwise.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="cfill-instruction"> cfill<a class="headerlink" href="#cfill-instruction" title="Permalink to this definition"></a></dt> <dd>Fills the current path with the specified color. This instruction completes the current path. Future path instructions will begin a new path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>mask (integer) – The channel mask to apply when filling the current path in the specified layer.</li> <li>layer (integer) – The layer whose path should be filled.</li> <li>r (integer) – The red component of the color to use to fill the current path in the specified layer.</li> <li>g (integer) – The green component of the color to use to fill the current path in the specified layer.</li> <li>b (integer) – The blue component of the color to use to fill the current path in the specified layer.</li> <li>a (integer) – The alpha component of the color to use to fill the current path in the specified layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="clip-instruction"> clip<a class="headerlink" href="#clip-instruction" title="Permalink to this definition"></a></dt> <dd>Applies the current path as the clipping path. Future operations will only draw within the current path. Note that future clip instructions will also be limited by this path. To set a completely new clipping path, you must first reset the layer with a reset instruction. If you wish to only reset the clipping path, but preserve the current transform matrix, push the layer state before setting the clipping path, and pop the layer state to reset. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose clipping path should be set. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="close-instruction"> close<a class="headerlink" href="#close-instruction" title="Permalink to this definition"></a></dt> <dd>Closes the current path by connecting the start and end points with a straight line. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose path should be closed. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="copy-instruction"> copy<a class="headerlink" href="#copy-instruction" title="Permalink to this definition"></a></dt> <dd>Copies image data from the specified rectangle of the specified layer or buffer to a different location of another specified layer or buffer. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>srclayer (integer) – The index of the layer to copy image data from.</li> <li>srcx (integer) – The X coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcy (integer) – The Y coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcwidth (integer) – The width of the source rectangle within the source layer.</li> <li>srcheight (integer) – The height of the source rectangle within the source layer.</li> <li>mask (integer) – The channel mask to apply when drawing the image data on the destination layer.</li> <li>dstlayer (integer) – The index of the layer to draw the image data to.</li> <li>dstx (integer) – The X coordinate of the upper-left corner of the destination within the destination layer.</li> <li>dsty (integer) – The Y coordinate of the upper-left corner of the destination within the destination layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="cstroke-instruction"> cstroke<a class="headerlink" href="#cstroke-instruction" title="Permalink to this definition"></a></dt> <dd>Strokes the current path with the specified color. This instruction completes the current path. Future path instructions will begin a new path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>mask (integer) – The channel mask to apply when stroking the current path in the specified layer.</li> <li>layer (integer) – The layer whose path should be stroked.</li> <li>cap (integer) – The index of the line cap style to use. This can be either butt (0), round (1), or square (2).</li> <li>join (integer) – The index of the line join style to use. This can be either bevel (0), miter (1), or round (2).</li> <li>thickness (integer) – The thickness of the stroke to draw, in pixels.</li> <li>r (integer) – The red component of the color to use to stroke the current path in the specified layer.</li> <li>g (integer) – The green component of the color to use to stroke the current path in the specified layer.</li> <li>b (integer) – The blue component of the color to use to stroke the current path in the specified layer.</li> <li>a (integer) – The alpha component of the color to use to stroke the current path in the specified layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="cursor-instruction"> cursor<a class="headerlink" href="#cursor-instruction" title="Permalink to this definition"></a></dt> <dd>Sets the client’s cursor to the image data from the specified rectangle of a layer, with the specified hotspot. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>x (integer) – The X coordinate of the cursor’s hotspot.</li> <li>y (integer) – The Y coordinate of the cursor’s hotspot.</li> <li>srclayer (integer) – The index of the layer to copy image data from.</li> <li>srcx (integer) – The X coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcy (integer) – The Y coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcwidth (integer) – The width of the source rectangle within the source layer.</li> <li>srcheight (integer) – The height of the source rectangle within the source layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="curve-instruction"> curve<a class="headerlink" href="#curve-instruction" title="Permalink to this definition"></a></dt> <dd>Adds the specified cubic bezier curve subpath. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer which should have the specified curve subpath added.</li> <li>cp1x (integer) – The X coordinate of the first control point of the curve.</li> <li>cp1y (integer) – The Y coordinate of the first control point of the curve.</li> <li>cp2x (integer) – The X coordinate of the second control point of the curve.</li> <li>cp2y (integer) – The Y coordinate of the second control point of the curve.</li> <li>x (integer) – The X coordinate of the endpoint of the curve.</li> <li>y (integer) – The Y coordinate of the endpoint of the curve.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="dispose-instruction"> dispose<a class="headerlink" href="#dispose-instruction" title="Permalink to this definition"></a></dt> <dd>Removes the specified layer. The specified layer will be recreated as a new layer if it is referenced again. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer to remove. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="distort-instruction"> distort<a class="headerlink" href="#distort-instruction" title="Permalink to this definition"></a></dt> <dd>Sets the given affine transformation matrix to the layer. Unlike transform, this operation is independent of any previously sent transformation matrix. This operation can be undone by setting the layer’s transformation matrix to the identity matrix using distort <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer to distort.</li> <li>a (float) – The matrix value in row 1, column 1.</li> <li>b (float) – The matrix value in row 2, column 1.</li> <li>c (float) – The matrix value in row 1, column 2.</li> <li>d (float) – The matrix value in row 2, column 2.</li> <li>e (float) – The matrix value in row 1, column 3.</li> <li>f (float) – The matrix value in row 2, column 3.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="identity-instruction"> identity<a class="headerlink" href="#identity-instruction" title="Permalink to this definition"></a></dt> <dd>Resets the transform matrix of the specified layer to the identity matrix. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose transform matrix should be reset. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="img-instruction"> img<a class="headerlink" href="#img-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the metadata of an image update, including the image type, the destination layer, and destination coordinates. The contents of the image will later be sent along the stream with blob instructions. The full size of the image need not be known ahead of time. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the image being sent.</li> <li>mask (integer) – The channel mask to apply when drawing the image data.</li> <li>layer (integer) – The destination layer.</li> <li>x (integer) – The X coordinate of the upper-left corner of the destination within the destination layer.</li> <li>y (integer) – The Y coordinate of the upper-left corner of the destination within the destination layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="lfill-instruction"> lfill<a class="headerlink" href="#lfill-instruction" title="Permalink to this definition"></a></dt> <dd>Fills the current path with a tiled pattern of the image data from the specified layer. This instruction completes the current path. Future path instructions will begin a new path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>mask (integer) – The channel mask to apply when filling the current path in the specified layer.</li> <li>layer (integer) – The layer whose path should be filled.</li> <li>srclayer (integer) – The layer to use as the pattern.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="line-instruction"> line<a class="headerlink" href="#line-instruction" title="Permalink to this definition"></a></dt> <dd>Adds the specified line subpath. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer which should have the specified line subpath added.</li> <li>x (integer) – The X coordinate of the endpoint of the line.</li> <li>y (integer) – The Y coordinate of the endpoint of the line.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="lstroke-instruction"> lstroke<a class="headerlink" href="#lstroke-instruction" title="Permalink to this definition"></a></dt> <dd>Strokes the current path with a tiled pattern of the image data from the specified layer. This instruction completes the current path. Future path instructions will begin a new path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>mask (integer) – The channel mask to apply when filling the current path in the specified layer.</li> <li>layer (integer) – The layer whose path should be filled.</li> <li>cap (integer) – The index of the line cap style to use. This can be either butt (0), round (1), or square (2).</li> <li>join (integer) – The index of the line join style to use. This can be either bevel (0), miter (1), or round (2).</li> <li>thickness (integer) – The thickness of the stroke to draw, in pixels.</li> <li>srclayer (integer) – The layer to use as the pattern.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="move-instruction"> move<a class="headerlink" href="#move-instruction" title="Permalink to this definition"></a></dt> <dd>Moves the given layer to the given location within the specified parent layer. This operation is applicable only to layers, and cannot be applied to buffers (layers with negative indices). Applying this operation to the default layer (layer 0) also has no effect. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer to move.</li> <li>parent (integer) – The layer that should be the parent of the given layer.</li> <li>x (integer) – The X coordinate to move the layer to.</li> <li>y (integer) – The Y coordinate to move the layer to.</li> <li>z (integer) – The relative Z-ordering of this layer. Layers with larger values will appear above layers with smaller values.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="pop-instruction"> pop<a class="headerlink" href="#pop-instruction" title="Permalink to this definition"></a></dt> <dd>Restores the previous state of the specified layer from the stack. The state restored includes the transformation matrix and clipping path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose state should be restored. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="push-instruction"> push<a class="headerlink" href="#push-instruction" title="Permalink to this definition"></a></dt> <dd>Saves the current state of the specified layer to the stack. The state saved includes the current transformation matrix and clipping path. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose state should be saved. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="rect-instruction"> rect<a class="headerlink" href="#rect-instruction" title="Permalink to this definition"></a></dt> <dd>Adds a rectangular path to the specified layer. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>mask (integer) – The channel mask to apply when drawing the image data.</li> <li>layer (integer) – The destination layer.</li> <li>x (integer) – The X coordinate of the upper-left corner of the rectangle to draw.</li> <li>y (integer) – The Y coordinate of the upper-left corner of the rectangle to draw.</li> <li>width (integer) – The width of the rectangle to draw.</li> <li>height (integer) – The width of the rectangle to draw.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="reset-instruction"> reset<a class="headerlink" href="#reset-instruction" title="Permalink to this definition"></a></dt> <dd>Resets the transformation and clip state of the layer. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">layer (integer) – The layer whose state should be reset. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="set-instruction"> set<a class="headerlink" href="#set-instruction" title="Permalink to this definition"></a></dt> <dd>Sets the given client-side property to the specified value. Currently there is only one property: miter-limit, the maximum distance between the inner and outer points of a miter joint, proportional to stroke width (if miter-limit is set to 10.0, the default, then the maximum distance between the points of the joint is 10 times the stroke width). <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer whose property should be set.</li> <li>property (string) – The name of the property to set.</li> <li>value (string) – The value to set the given property to.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="shade-instruction"> shade<a class="headerlink" href="#shade-instruction" title="Permalink to this definition"></a></dt> <dd>Sets the opacity of the given layer. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer whose opacity should be set.</li> <li>opacity (integer) – The opacity of the layer, where 0 is completely transparent, and 255 is completely opaque.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="size-instruction"> size<a class="headerlink" href="#size-instruction" title="Permalink to this definition"></a></dt> <dd>Sets the size of the specified layer. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer to resize.</li> <li>width (integer) – The new width of the layer</li> <li>height (integer) – The new height of the layer</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="start-instruction"> start<a class="headerlink" href="#start-instruction" title="Permalink to this definition"></a></dt> <dd>Starts a new subpath at the specified point. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer which should start a new subpath.</li> <li>x (integer) – The X coordinate of the first point of the new subpath.</li> <li>y (integer) – The Y coordinate of the first point of the new subpath.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="transfer-instruction"> transfer<a class="headerlink" href="#transfer-instruction" title="Permalink to this definition"></a></dt> <dd>Transfers image data from the specified rectangle of the specified layer or buffer to a different location of another specified layer or buffer, using the specified transfer function. For a list of available functions, see the definition of <code class="docutils literal notranslate">guac_transfer_function</code> within the <a class="reference external" href="https://github.com/apache/guacamole-server/blob/master/src/libguac/guacamole/protocol-types.h">guacamole/protocol-types.h</a> header included with libguac. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>srclayer (integer) – The index of the layer to transfer image data from.</li> <li>srcx (integer) – The X coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcy (integer) – The Y coordinate of the upper-left corner of the source rectangle within the source layer.</li> <li>srcwidth (integer) – The width of the source rectangle within the source layer.</li> <li>srcheight (integer) – The height of the source rectangle within the source layer.</li> <li>function (integer) – The index of the transfer function to use. For a list of available functions, see the definition of <code class="docutils literal notranslate">guac_transfer_function</code> within the <a class="reference external" href="https://github.com/apache/guacamole-server/blob/master/src/libguac/guacamole/protocol-types.h">guacamole/protocol-types.h</a> header included with libguac. </li> <li>dstlayer (integer) – The index of the layer to draw the image data to.</li> <li>dstx (integer) – The X coordinate of the upper-left corner of the destination within the destination layer.</li> <li>dsty (integer) – The Y coordinate of the upper-left corner of the destination within the destination layer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="transform-instruction"> transform<a class="headerlink" href="#transform-instruction" title="Permalink to this definition"></a></dt> <dd>Applies the specified transformation matrix to future operations. Unlike distort, this operation is dependent on any previously sent transformation matrices, and only affects future operations. This operation can be undone by setting the layer’s transformation matrix to the identity matrix using identity, but image data already drawn will not be affected. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>layer (integer) – The layer to apply the given transformation matrix to.</li> <li>a (float) – The matrix value in row 1, column 1.</li> <li>b (float) – The matrix value in row 2, column 1.</li> <li>c (float) – The matrix value in row 1, column 2.</li> <li>d (float) – The matrix value in row 2, column 2.</li> <li>e (float) – The matrix value in row 1, column 3.</li> <li>f (float) – The matrix value in row 2, column 3.</li> </ul> </dd> </dl> </dd></dl> </section> <section id="streaming-instructions"> <h2>Streaming instructions<a class="headerlink" href="#streaming-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="ack-instruction"> ack<a class="headerlink" href="#ack-instruction" title="Permalink to this definition"></a></dt> <dd>The ack instruction acknowledges a received data blob, providing a status code and message indicating whether the operation associated with the blob succeeded or failed. A status code other than 0 (<code class="docutils literal notranslate">SUCCESS</code>) implicitly ends the stream. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream the corresponding blob was received on.</li> <li>message (string) – A human-readable error message. This typically is not exposed within any user interface, and mainly helps with debugging.</li> <li>status (integer) – The Guacamole status code denoting success or failure. For a list of status codes, see the table in <a class="reference external" href="#status-codes">Status codes</a>.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="argv-instruction"> argv<a class="headerlink" href="#argv-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given argument (connection parameter) metadata. The relevant connection parameter data will later be sent along the stream with blob instructions. If sent by the client, this data will be the desired new value of the connection parameter being changed, and will be applied if the server supports changing that connection parameter while the connection is active. If sent by the server, this data will be the current value of a connection parameter being exposed to the client. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the connection parameter being sent. In most cases, this will be “text/plain”.</li> <li>name (string) – The name of the connection parameter whose value is being sent.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="audio-instruction"> audio<a class="headerlink" href="#audio-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given audio metadata. Audio data will later be sent along the stream with blob instructions. The mimetype given must be a mimetype previously specified by the client during the handshake procedure. Playback will begin immediately and will continue as long as blobs are received along the stream. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the audio data being sent.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="blob-instruction"> blob<a class="headerlink" href="#blob-instruction" title="Permalink to this definition"></a></dt> <dd>Sends a blob of data along the given stream. This blob of data is arbitrary, base64-encoded data, and only has meaning to the Guacamole client or server through the metadata assigned to the stream when the stream was allocated. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream along which the given data should be sent.</li> <li>data (string) – The base64-encoded data to send.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="clipboard-instruction"> clipboard<a class="headerlink" href="#clipboard-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given clipboard metadata. The clipboard data will later be sent along the stream with blob instructions. If sent by the client, this data will be the contents of the client-side clipboard. If sent by the server, this data will be the contents of the clipboard within the remote desktop. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the clipboard data being sent. In most cases, this will be “text/plain”.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="end-instruction"> end<a class="headerlink" href="#end-instruction" title="Permalink to this definition"></a></dt> <dd>The end instruction terminates an open stream, freeing any client-side or server-side resources. Data sent to a terminated stream will be ignored. Terminating a stream with the end instruction only denotes the end of the stream and does not imply an error. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">stream (integer) – The index of the stream the corresponding blob was received on. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="file-instruction"> file<a class="headerlink" href="#file-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given arbitrary file metadata. The contents of the file will later be sent along the stream with blob instructions. The full size of the file need not be known ahead of time. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the file being sent.</li> <li>filename (string) – The name of the file, as it would be saved on a filesystem.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="msg-instruction"> msg<a class="headerlink" href="#msg-instruction" title="Permalink to this definition"></a></dt> <dd>Sends a message from the server (guacd) to the client. The nature of these messages is intentionally broad and flexible - the message must include a numeric code that the client understands and can act on, and may also any number of arguments that can be used by the client in association with the message. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>msg (integer) – A numeric value indicating the message that is being passed to the client.</li> <li>args (string) – Any number of arguments associated with the message that is being sent to the client.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="pipe-instruction"> pipe<a class="headerlink" href="#pipe-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given arbitrary named pipe metadata. The contents of the pipe will later be sent along the stream with blob instructions. Pipes in the Guacamole protocol are unidirectional, named pipes, very similar to a UNIX FIFO or pipe. It is up to client-side code to handle pipe data appropriately, likely based upon the name of the pipe, which is arbitrary. Pipes may be opened by either the client or the server. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the data being sent along the pipe.</li> <li>name (string) – The arbitrary name of the pipe, which may have special meaning to client-side code.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="video-instruction"> video<a class="headerlink" href="#video-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given video metadata. Video data will later be sent along the stream with blob instructions. The mimetype given must be a mimetype previously specified by the client during the handshake procedure. Playback will begin immediately and will continue as long as blobs are received along the stream. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>stream (integer) – The index of the stream to allocate.</li> <li>layer (integer) – The index of the layer to stream the video data into. The effect of other drawing operations on this layer during playback is undefined, as the client codec implementation may leverage any rendering mechanism it sees fit, including hardware decoding.</li> <li>mimetype (string) – The mimetype of the video data being sent.</li> </ul> </dd> </dl> </dd></dl> </section> <section id="object-instructions"> <h2>Object instructions<a class="headerlink" href="#object-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="body-instruction"> body<a class="headerlink" href="#body-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the name of a stream previously requested by a get instruction. The contents of the stream will be sent later with blob instructions. The full size of the stream need not be known ahead of time. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>object (integer) – The index of the object associated with this stream.</li> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the data being sent.</li> <li>name (string) – The name of the stream associated with the object.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="filesystem-instruction"> filesystem<a class="headerlink" href="#filesystem-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new object, associating it with the given arbitrary filesystem metadata. The contents of files and directories within the filesystem will later be sent along streams requested with get instructions or created with put instructions. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>object (integer) – The index of the object to allocate.</li> <li>name (string) – The name of the filesystem.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="get-instruction"> get<a class="headerlink" href="#get-instruction" title="Permalink to this definition"></a></dt> <dd>Requests that a new stream be created, providing read access to the object stream having the given name. The requested stream will be created, in response, with a body instruction. Stream names are arbitrary and dictated by the object from which they are requested, with the exception of the root stream of the object itself, which has the reserved name “<code class="docutils literal notranslate">/</code>”. The root stream of the object has the mimetype “<code class="docutils literal notranslate">application/vnd.glyptodon.guacamole.stream-index+json</code>”, and provides a simple JSON map of available stream names to their corresponding mimetypes. If the object contains a hierarchy of streams, some of these streams may also be “<code class="docutils literal notranslate">application/vnd.glyptodon.guacamole.stream-index+json</code>”. For example, the ultimate content of the body stream provided in response to a get request for the root stream of an object containing two text streams, “A” and “B”, would be the following: <div class="highlight-json notranslate"><div class="highlight"><pre>{ "A" : "text/plain", "B" : "text/plain" } </pre></div> </div> <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>object (integer) – The index of the object to request a stream from.</li> <li>name (string) – The name of the stream being requested from the given object.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="put-instruction"> put<a class="headerlink" href="#put-instruction" title="Permalink to this definition"></a></dt> <dd>Allocates a new stream, associating it with the given arbitrary object and stream name. The contents of the stream will later be sent with blob instructions. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>object (integer) – The index of the object associated with this stream.</li> <li>stream (integer) – The index of the stream to allocate.</li> <li>mimetype (string) – The mimetype of the data being sent.</li> <li>name (string) – The name of the stream within the given object to which data is being sent.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="undefine-instruction"> undefine<a class="headerlink" href="#undefine-instruction" title="Permalink to this definition"></a></dt> <dd>Undefines an existing object, allowing its index to be reused by another future object. The resource associated with the original object may or may not continue to exist - it simply no longer has an associated object. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">object (integer) – The index of the object to undefine. </dd> </dl> </dd></dl> </section> <section id="client-handshake-instructions"> <h2>Client handshake instructions<a class="headerlink" href="#client-handshake-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-audio-handshake-instruction"> audio<a class="headerlink" href="#client-audio-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies which audio mimetypes are supported by the client. Each parameter must be a single mimetype, listed in order of client preference, with the optimal mimetype being the first parameter. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-connect-handshake-instruction"> connect<a class="headerlink" href="#client-connect-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Begins the connection using the previously specified protocol with the given arguments. This is the last instruction sent during the handshake phase. The parameters of this instruction correspond exactly to the parameters of the received args instruction. If the received args instruction has, for example, three parameters, the responding connect instruction must also have three parameters. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-image-handshake-instruction"> image<a class="headerlink" href="#client-image-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies which image mimetypes are supported by the client. Each parameter must be a single mimetype, listed in order of client preference, with the optimal mimetype being the first parameter. It is expected that the supported mimetypes will include at least “image/png” and “image/jpeg”, and the server may safely assume that these mimetypes are supported, even if they are absent from the handshake. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-name-handshake-instruction"> name<a class="headerlink" href="#client-name-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies the human-readable name of the user joining a connection. A single, string value is expected for this, and guacd does not expect or require that this value be unique among other users connected to the server or connection. The type of name provided is completely up to the client implementation. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-select-handshake-instruction"> select<a class="headerlink" href="#client-select-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Requests that the connection be made using the specified protocol, or to the specified existing connection. Whether a new connection is established or an existing connection is joined depends on whether the ID of an active connection is provided. The Guacamole protocol dictates that the IDs generated for active connections (provided during the handshake of those connections via the <a class="reference external" href="#ready-instruction">ready instruction</a>) must not collide with any supported protocols. This is the first instruction sent during the handshake phase. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">identifier (string) – The name of the protocol to use, such as “vnc” or “rdp”, or the ID of the active connection to be joined, as returned via the <a class="reference external" href="#ready-instruction">ready instruction</a>. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-size-handshake-instruction"> size<a class="headerlink" href="#client-size-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies the client’s optimal screen size and resolution. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>width (integer) – The optimal screen width.</li> <li>height (integer) – The optimal screen height.</li> <li>dpi (integer) – The optimal screen resolution, in approximate DPI.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-timezone-handshake-instruction"> timezone<a class="headerlink" href="#client-timezone-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies the timezone of the client system, in IANA zone key format. This is a single-value parameter, and may be used by protocols to set the timezone on the remote computer, if the remote system allows the timezone to be configured. This instruction is optional. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">timezone (string) – </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-video-handshake-instruction"> video<a class="headerlink" href="#client-video-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies which video mimetypes are supported by the client. Each parameter must be a single mimetype, listed in order of client preference, with the optimal mimetype being the first parameter. </dd></dl> </section> <section id="server-handshake-instructions"> <h2>Server handshake instructions<a class="headerlink" href="#server-handshake-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="args-handshake-instruction"> args<a class="headerlink" href="#args-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>Reports the expected format of the argument list for the protocol requested by the client. This message can be sent by the server during the handshake phase only. The first parameter of this instruction will be the protocol version supported by the server. This is used to negotiate protocol compatibility between the client and the server, with the highest supported protocol by both sides being chosen. Versions of Guacamole prior to 1.1.0 do not support protocol version negotiation, and will silently ignore this instruction. The remaining parameters of the args instruction are the names of all connection parameters accepted by the server for the protocol selected by the client, in order. The client’s responding connect instruction must contain the values of each of these parameters in the same order. </dd></dl> </section> <section id="control-instructions"> <h2>Control instructions<a class="headerlink" href="#control-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="disconnect-instruction"> disconnect<a class="headerlink" href="#disconnect-instruction" title="Permalink to this definition"></a></dt> <dd>Notifies the client or server that the connection is about to be closed. This message can be sent during any phase, and takes no parameters. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="nop-instruction"> nop<a class="headerlink" href="#nop-instruction" title="Permalink to this definition"></a></dt> <dd>The “nop” instruction does absolutely nothing, has no parameters, and is universally ignored by both Guacamole clients and servers. Its main use is as a keep-alive signal, and may be sent by guacd, client plugins, or web applications when there is no activity to ensure the socket is not closed due to timeout. </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="sync-instruction"> sync<a class="headerlink" href="#sync-instruction" title="Permalink to this definition"></a></dt> <dd>Reports that all operations as of the given server-relative timestamp have been completed. Both client and server are expected to occasionally send sync to report on current operation execution state, with the server using sync to denote the end of a logical frame. If a sync is received from the server, the client must respond with a corresponding sync once all previous operations have been completed, or the server may stop sending updates until the client catches up. For the client, sending a sync with a timestamp newer than any timestamp received from the server is an error. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">timestamp (integer) – A valid server-relative timestamp. </dd> </dl> </dd></dl> </section> <section id="server-control-instructions"> <h2>Server control instructions<a class="headerlink" href="#server-control-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="error-instruction"> error<a class="headerlink" href="#error-instruction" title="Permalink to this definition"></a></dt> <dd>Notifies the client that the connection is about to be closed due to the specified error. This message can be sent by the server during any phase. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>message (string) – An arbitrary message describing the error</li> <li>status (integer) – The Guacamole status code describing the error. For a list of status codes, see the table in <a class="reference external" href="#status-codes">Status codes</a>.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="log-instruction"> log<a class="headerlink" href="#log-instruction" title="Permalink to this definition"></a></dt> <dd>The log instruction sends an arbitrary string for debugging purposes. This instruction will be ignored by Guacamole clients, but can be seen in protocol dumps if such dumps become necessary. Sending a log instruction can help add context when searching for the cause of a fault in protocol support. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">message (string) – An arbitrary, human-readable message. </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="mouse-instruction"> mouse<a class="headerlink" href="#mouse-instruction" title="Permalink to this definition"></a></dt> <dd>Reports that a user on the current connection has moved the mouse to the given coordinates. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>x (integer) – The current X coordinate of the mouse pointer.</li> <li>y (integer) – The current Y coordinate of the mouse pointer.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="ready-handshake-instruction"> ready<a class="headerlink" href="#ready-handshake-instruction" title="Permalink to this definition"></a></dt> <dd>The ready instruction sends the ID of a new connection and marks the beginning of the interactive phase of a new, successful connection. The ID sent is a completely arbitrary string, and has no standard format. It must be unique from all existing and future connections and may not match the name of any installed protocol support. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd">identifier (string) – An arbitrary, unique identifier for the current connection. This identifier must be unique from all existing and future connections, and may not match the name of any installed protocol support (such as “vnc” or “rdp”). </dd> </dl> </dd></dl> </section> <section id="input-event-instructions"> <h2>Input/Event instructions<a class="headerlink" href="#input-event-instructions" title="Permalink to this heading"></a></h2> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-key-instruction"> key<a class="headerlink" href="#client-key-instruction" title="Permalink to this definition"></a></dt> <dd>Sends the specified key press or release event. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>keysym (integer) – The <a class="reference external" href="https://www.x.org/releases/X11R7.6/doc/xproto/x11protocol.html#keysym_encoding">X11 keysym</a> of the key being pressed or released.</li> <li>pressed (integer) – 0 if the key is not pressed, 1 if the key is pressed.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-mouse-instruction"> mouse<a class="headerlink" href="#client-mouse-instruction" title="Permalink to this definition"></a></dt> <dd>Sends the specified mouse movement or button press or release event (or combination thereof). <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>x (integer) – The current X coordinate of the mouse pointer.</li> <li>y (integer) – The current Y coordinate of the mouse pointer.</li> <li>mask (integer) – The button mask, representing the pressed or released status of each mouse button.</li> </ul> </dd> </dl> </dd></dl> <dl class="guac instruction"> <dt class="sig sig-object guac" id="client-size-instruction"> size<a class="headerlink" href="#client-size-instruction" title="Permalink to this definition"></a></dt> <dd>Specifies that the client’s optimal screen size has changed from what was specified during the handshake, or from previously-sent “size” instructions. <dl class="field-list simple"> <dt class="field-odd">Arguments:</dt> <dd class="field-odd"><ul class="simple"> <li>width (integer) – The new, optimal screen width.</li> <li>height (integer) – The new, optimal screen height.</li> </ul> </dd> </dl> </dd></dl> </section> <section id="status-codes"> <h2>Status codes<a class="headerlink" href="#status-codes" title="Permalink to this heading"></a></h2> Several Guacamole instructions, and various other internals of the Guacamole core, use a common set of numeric status codes. These codes denote success or failure of operations, and can be rendered by user interfaces in a human-readable way. <dl class="simple"> <dt>0 (<code class="docutils literal notranslate">SUCCESS</code>)</dt><dd>The operation succeeded. No error. </dd> <dt>256 (<code class="docutils literal notranslate">UNSUPPORTED</code>)</dt><dd>The requested operation is unsupported. </dd> <dt>512 (<code class="docutils literal notranslate">SERVER_ERROR</code>)</dt><dd>An internal error occurred, and the operation could not be performed. </dd> <dt>513 (<code class="docutils literal notranslate">SERVER_BUSY</code>)</dt><dd>The operation could not be performed because the server is busy. </dd> <dt>514 (<code class="docutils literal notranslate">UPSTREAM_TIMEOUT</code>)</dt><dd>The upstream server is not responding. In most cases, the upstream server is the remote desktop server. </dd> <dt>515 (<code class="docutils literal notranslate">UPSTREAM_ERROR</code>)</dt><dd>The upstream server encountered an error. In most cases, the upstream server is the remote desktop server. </dd> <dt>516 (<code class="docutils literal notranslate">RESOURCE_NOT_FOUND</code>)</dt><dd>An associated resource, such as a file or stream, could not be found, and thus the operation failed. </dd> <dt>517 (<code class="docutils literal notranslate">RESOURCE_CONFLICT</code>)</dt><dd>A resource is already in use or locked, preventing the requested operation. </dd> <dt>518 (<code class="docutils literal notranslate">RESOURCE_CLOSED</code>)</dt><dd>The requested operation cannot continue because the associated resource has been closed. </dd> <dt>519 (<code class="docutils literal notranslate">UPSTREAM_NOT_FOUND</code>)</dt><dd>The upstream server does not appear to exist, or cannot be reached over the network. In most cases, the upstream server is the remote desktop server. </dd> <dt>520 (<code class="docutils literal notranslate">UPSTREAM_UNAVAILABLE</code>)</dt><dd>The upstream server is refusing to service connections. In most cases, the upstream server is the remote desktop server. </dd> <dt>521 (<code class="docutils literal notranslate">SESSION_CONFLICT</code>)</dt><dd>The session within the upstream server has ended because it conflicts with another session. In most cases, the upstream server is the remote desktop server. </dd> <dt>522 (<code class="docutils literal notranslate">SESSION_TIMEOUT</code>)</dt><dd>The session within the upstream server has ended because it appeared to be inactive. In most cases, the upstream server is the remote desktop server. </dd> <dt>523 (<code class="docutils literal notranslate">SESSION_CLOSED</code>)</dt><dd>The session within the upstream server has been forcibly closed. In most cases, the upstream server is the remote desktop server. </dd> <dt>768 (<code class="docutils literal notranslate">CLIENT_BAD_REQUEST</code>)</dt><dd>The parameters of the request are illegal or otherwise invalid. </dd> <dt>769 (<code class="docutils literal notranslate">CLIENT_UNAUTHORIZED</code>)</dt><dd>Permission was denied, because the user is not logged in. Note that the user may be logged into Guacamole, but still not logged in with respect to the remote desktop server. </dd> <dt>771 (<code class="docutils literal notranslate">CLIENT_FORBIDDEN</code>)</dt><dd>Permission was denied, and logging in will not solve the problem. </dd> <dt>776 (<code class="docutils literal notranslate">CLIENT_TIMEOUT</code>)</dt><dd>The client (usually the user of Guacamole or their browser) is taking too long to respond. </dd> <dt>781 (<code class="docutils literal notranslate">CLIENT_OVERRUN</code>)</dt><dd>The client has sent more data than the protocol allows. </dd> <dt>783 (<code class="docutils literal notranslate">CLIENT_BAD_TYPE</code>)</dt><dd>The client has sent data of an unexpected or illegal type. </dd> <dt>797 (<code class="docutils literal notranslate">CLIENT_TOO_MANY</code>)</dt><dd>The client is already using too many resources. Existing resources must be freed before further requests are allowed. </dd> </dl> </section> <section id="message-codes"> <h2>Message Codes<a class="headerlink" href="#message-codes" title="Permalink to this heading"></a></h2> The <cite>msg</cite> instruction must have at least one numeric argument that the client then uses to interpret the message and determine what action, if any, it should take based on the message. The following numeric codes are currently implemented for this instruction. <dl class="simple"> <dt>1 (<code class="docutils literal notranslate">USER_JOINED</code>)</dt><dd>Notifies the owner of a connection that another user has joined the connection. This message is expected to include two additional arguments: the guacd-generated UUID of the user who is joining the connection, and the arbitrary name of the user provided by the client during the handshake. </dd> <dt>2 (<code class="docutils literal notranslate">USER_LEFT</code>)</dt><dd>Notifies the owner of a connection that another user has left the connection. This message is expected to include two additional arguments: the guacd-generated UUID of the user who is leaving the connection, and the arbitrary name of the user provided by the client during the handshake. </dd> </dl> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="writing-you-own-guacamole-app.html" class="btn btn-neutral float-left" title="Writing your own Guacamole application" accesskey="p" rel="prev"> Previous</a> </div> <hr/> <div role="contentinfo"> Copyright © 2023 <a href="http://www.apache.org/">The Apache Software Foundation</a>, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. Apache Guacamole, Guacamole, Apache, the Apache feather logo, and the Apache Guacamole project logo are trademarks of The Apache Software Foundation. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script>  <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-75289145-1', 'auto'); ga('send', 'pageview'); </script> </body> </html>

doc/gug/protocol-reference.html (1,256 lines of code) (raw):