/usr/share/doc/x11proto-bigreqs-dev/bigreq.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Big Requests Extension</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><style xmlns="" type="text/css">/*
 * Copyright (c) 2011 Gaetan Nadon
 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

/*
 * Shared stylesheet for X.Org documentation translated to HTML format
 * http://www.sagehill.net/docbookxsl/UsingCSS.html
 * http://www.w3schools.com/css/default.asp
 * https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers
 * https://addons.mozilla.org/en-US/firefox/addon/font-finder/
 */

/*
 * The sans-serif fonts are considered more legible on a computer screen
 * http://dry.sailingissues.com/linux-equivalents-verdana-arial.html
 *
 */
body {
  font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif;
  /* In support of using "em" font size unit, the w3c recommended method */
  font-size: 100%;
}

/*
 * Selection: all elements requiring mono spaced fonts.
 *
 * The family names attempt to match the proportionally spaced font
 * family names such that the same font name is used for both.
 * We'd like to use Bitstream, for example, in both proportionally and
 * mono spaced font text.
 */
.command,
.errorcode,
.errorname,
.errortype,
.filename,
.funcsynopsis,
.function,
.parameter,
.programlisting,
.property,
.screen,
.structname,
.symbol,
.synopsis,
.type
{
  font-family:  "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace;
}

/*
 * Books have a title page, a preface, some chapters and appendices,
 * a glossary, an index and a bibliography, in that order.
 *
 * An Article has no preface and no chapters. It has sections, appendices,
 * a glossary, an index and a bibliography.
 */

/*
 * Selection: book main title and subtitle
 */
div.book>div.titlepage h1.title,
div.book>div.titlepage h2.subtitle {
  text-align: center;
}

/*
 * Selection: article main title and subtitle
 */
div.article>div.titlepage h2.title,
div.article>div.titlepage h3.subtitle,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title {
  text-align: center;
}

/*
 * Selection: various types of authors and collaborators, individuals or corporate
 *
 * These authors are not always contained inside an authorgroup.
 * They can be contained inside a lot of different parent types where they might
 * not be centered.
 * Reducing the margin at the bottom makes a visual separation between authors
 * We specify here the ones on the title page, others may be added based on merit.
 */
div.titlepage .authorgroup,
div.titlepage .author,
div.titlepage .collab,
div.titlepage .corpauthor,
div.titlepage .corpcredit,
div.titlepage .editor,
div.titlepage .othercredit {
  text-align: center;
  margin-bottom: 0.25em;
}

/*
 * Selection: the affiliation of various types of authors and collaborators,
 * individuals or corporate.
 */
div.titlepage .affiliation {
  text-align: center;
}

/*
 * Selection: product release information (X Version 11, Release 7)
 *
 * The releaseinfo element can be contained inside a lot of different parent
 * types where it might not be centered.
 * We specify here the one on the title page, others may be added based on merit.
 */
div.titlepage p.releaseinfo {
  font-weight: bold;
  text-align: center;
}

/*
 * Selection: publishing date
 */
div.titlepage .pubdate {
  text-align: center;
}

/*
 * The legal notices are displayed in smaller sized fonts
 * Justification is only supported in IE and therefore not requested.
 *
 */
.legalnotice {
  font-size: small;
  font-style: italic;
}

/*
 * Selection: book or article main ToC title
 * A paragraph is generated for the title rather than a level 2 heading.
 * We do not want to select chapters sub table of contents, only the main one
 */
div.book>div.toc>p,
div.article>div.toc>p {
  font-size: 1.5em;
  text-align: center;
}

/*
 * Selection: major sections of a book or an article
 *
 * Unlike books, articles do not have a titlepage element for appendix.
 * Using the selector "div.titlepage h2.title" would be too general.
 */
div.book>div.preface>div.titlepage h2.title,
div.book>div.chapter>div.titlepage h2.title,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title,
div.book>div.appendix>div.titlepage h2.title,
div.article>div.appendix h2.title,
div.glossary>div.titlepage h2.title,
div.index>div.titlepage h2.title,
div.bibliography>div.titlepage h2.title {
   /* Add a border top over the major parts, just like printed books */
   /* The Gray color is already used for the ruler over the main ToC. */
  border-top-style: solid;
  border-top-width: 2px;
  border-top-color: Gray;
  /* Put some space between the border and the title */
  padding-top: 0.2em;
  text-align: center;
}

/*
 * A Screen is a verbatim environment for displaying text that the user might
 * see on a computer terminal. It is often used to display the results of a command.
 *
 * http://www.css3.info/preview/rounded-border/
 */
.screen {
  background: #e0ffff;
  border-width: 1px;
  border-style: solid;
  border-color: #B0C4DE;
  border-radius: 1.0em;
  /* Browser's vendor properties prior to CSS 3 */
  -moz-border-radius: 1.0em;
  -webkit-border-radius: 1.0em;
  -khtml-border-radius: 1.0em;
  margin-left: 1.0em;
  margin-right: 1.0em;
  padding: 0.5em;
}

/*
 * Emphasis program listings with a light shade of gray similar to what
 * DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html
 * Found many C API docs on the web using like shades of gray.
 */
.programlisting {
  background: #F4F4F4;
  border-width: 1px;
  border-style: solid;
  border-color: Gray;
  padding: 0.5em;
}

/*
 * Emphasis functions synopsis using a darker shade of gray.
 * Add a border such that it stands out more.
 * Set the padding so the text does not touch the border.
 */
.funcsynopsis, .synopsis {
  background: #e6e6fa;
  border-width: 1px;
  border-style: solid;
  border-color: Gray;
  clear: both;
  margin: 0.5em;
  padding: 0.25em;
}

/*
 * Selection: paragraphs inside synopsis
 *
 * Removes the default browser margin, let the container set the padding.
 * Paragraphs are not always used in synopsis
 */
.funcsynopsis p,
.synopsis p {
  margin: 0;
  padding: 0;
}

/*
 * Selection: variable lists, informal tables and tables
 *
 * Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl
 * A table with rows and columns is constructed inside div.variablelist
 *
 * Set the left margin so it is indented to the right
 * Display informal tables with single line borders
 */
table {
  margin-left: 0.5em;
  border-collapse: collapse;
}

/*
 * Selection: paragraphs inside tables
 *
 * Removes the default browser margin, let the container set the padding.
 * Paragraphs are not always used in tables
 */
td p {
  margin: 0;
  padding: 0;
}

/*
 * Add some space between the left and right column.
 * The vertical alignment helps the reader associate a term
 * with a multi-line definition.
 */
td, th {
  padding-left: 1.0em;
  padding-right: 1.0em;
  vertical-align: top;
}

.warning {
  border: 1px solid red;
  background: #FFFF66;
  padding-left: 0.5em;
}
</style></head><body><div class="book" title="Big Requests Extension"><div class="titlepage"><div><div><h1 class="title"><a id="bigreq"></a>Big Requests Extension</h1></div><div><h2 class="subtitle">X Consortium Standard</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Bob</span> <span class="surname">Scheifler</span></h3><div class="affiliation"><span class="orgname">X Consortium<br /></span></div></div></div></div><div><p class="releaseinfo">X Version 11, Release 7.6</p></div><div><p class="releaseinfo">Version 2.0</p></div><div><p class="copyright">Copyright © 1993, 1994 X Consortium</p></div><div><div class="legalnotice" title="Legal Notice"><a id="idp28571280"></a><p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p><p>Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium.</p><p>X Window System is a trademark of The Open Group.</p></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="chapter"><a href="#Overview">1. Overview</a></span></dt><dt><span class="chapter"><a href="#Requests">2. Requests</a></span></dt><dt><span class="chapter"><a href="#Events_and_Errors">3. Events and Errors</a></span></dt><dt><span class="chapter"><a href="#Encoding">4. Encoding</a></span></dt><dt><span class="chapter"><a href="#C_Language_Binding">5. C language binding</a></span></dt><dt><span class="chapter"><a href="#Acknowledgements">6. Acknowledgements</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Overview"><div class="titlepage"><div><div><h2 class="title"><a id="Overview"></a>Chapter 1. Overview</h2></div></div></div><p>This extension enables the use of protocol requests that exceed 262140 bytes in length.</p><p>The core protocol restricts the maximum length of a protocol request to 262140 bytes, in that it uses a 16-bit length field specifying the number of 4-byte units in the request.  This is a problem in the core protocol when joining large numbers of lines (<span class="symbol">PolyLine</span>) or arcs (<span class="symbol">PolyArc</span>), since these requests cannot be broken up into smaller requests without disturbing the rendering of the join points.  It is also much more of a problem for protocol extensions, such as the PEX extension for 3D graphics and the XIE extension for imaging, that need to send long data lists in output commands.</p><p>This extension defines a mechanism for extending the length field beyond 16 bits.  If the normal 16-bit length field of the protocol request is zero, then an additional 32-bit field containing the actual length (in 4-byte units) is inserted into the request, immediately following the 16-bit length field.</p><p>For example, a normal <code class="function">PolyLine</code> encoding is:</p><div class="informaltable"><a id="PolyLine"></a><table border="0"><colgroup><col align="left" class="c1" /><col align="left" class="c2" /><col align="left" class="c3" /><col align="left" class="c4" /></colgroup><thead><tr><th colspan="4" align="left"><code class="function">PolyLine</code></th></tr></thead><tbody><tr><td align="left">1</td><td align="left">65</td><td align="left"> </td><td align="left">opcode</td></tr><tr><td align="left">1</td><td align="left"> </td><td align="left"> </td><td align="left">coordinate-mode</td></tr><tr><td align="left"> </td><td align="left">0</td><td align="left">Origin</td><td align="left"> </td></tr><tr><td align="left"> </td><td align="left">1</td><td align="left">Previous</td><td align="left"> </td></tr><tr><td align="left">2</td><td align="left">3+n</td><td align="left"> </td><td align="left"> </td></tr><tr><td align="left">4</td><td align="left">DRAWABLE</td><td align="left"> </td><td align="left">drawable</td></tr><tr><td align="left">4</td><td align="left">GCONTEXT</td><td align="left"> </td><td align="left">gc</td></tr><tr><td align="left">4n</td><td align="left">LISTofPOINT</td><td align="left"> </td><td align="left">points</td></tr></tbody></table></div><p>An extended-length <code class="function">PolyLine</code> encoding is:</p><div class="informaltable"><table border="0"><colgroup><col align="left" class="c1" /><col align="left" class="c2" /><col align="left" class="c3" /><col align="left" class="c4" /></colgroup><thead><tr><th colspan="4" align="left"><code class="function">PolyLine</code></th></tr></thead><tbody><tr><td align="left">1</td><td align="left">65</td><td align="left"> </td><td align="left">opcode</td></tr><tr><td align="left">1</td><td align="left"> </td><td align="left"> </td><td align="left">coordinate-mode</td></tr><tr><td align="left"> </td><td align="left">0</td><td align="left">Origin</td><td align="left"> </td></tr><tr><td align="left"> </td><td align="left">1</td><td align="left">Previous</td><td align="left"> </td></tr><tr><td align="left">2</td><td align="left">0</td><td align="left"> </td><td align="left">extended length flag</td></tr><tr><td align="left">4</td><td align="left">4+n</td><td align="left"> </td><td align="left">request length</td></tr><tr><td align="left">4</td><td align="left">DRAWABLE</td><td align="left"> </td><td align="left">drawable</td></tr><tr><td align="left">4</td><td align="left">GCONTEXT</td><td align="left"> </td><td align="left">gc</td></tr><tr><td align="left">4n</td><td align="left">LISTofPOINT</td><td align="left"> </td><td align="left">points</td></tr></tbody></table></div><p>Extended-length protocol encodings, once enabled, can be used on all protocol requests, including all extensions.</p></div><div class="chapter" title="Chapter 2. Requests"><div class="titlepage"><div><div><h2 class="title"><a id="Requests"></a>Chapter 2. Requests</h2></div></div></div><p><code class="function">BigReqEnable</code></p><p>   =&gt;</p><p><span class="emphasis"><em>maximum-request-length</em></span>: CARD32</p><p>This request enables extended-length protocol requests for the requesting client.  It also returns the maximum length of a request, in 4-byte units, that can be used in extended-length protocol requests.  This value will always be greater than the maximum-request-length returned in the connection setup information.</p></div><div class="chapter" title="Chapter 3. Events and Errors"><div class="titlepage"><div><div><h2 class="title"><a id="Events_and_Errors"></a>Chapter 3. Events and Errors</h2></div></div></div><p>No new events or errors are defined by this extension.</p></div><div class="chapter" title="Chapter 4. Encoding"><div class="titlepage"><div><div><h2 class="title"><a id="Encoding"></a>Chapter 4. Encoding</h2></div></div></div><p>Please refer to the X11 Protocol Encoding document as this document uses conventions established there.</p><p>The name of this extension is “BIG-REQUESTS”.</p><div class="informaltable"><table border="0"><colgroup><col align="left" class="c1" /><col align="left" class="c2" /><col align="left" class="c3" /></colgroup><thead><tr><th colspan="3" align="left">BigReqEnable</th></tr></thead><tbody><tr><td align="left">1</td><td align="left">Card8</td><td align="left">opcode</td></tr><tr><td align="left">1</td><td align="left">0</td><td align="left">bigreq opcode</td></tr><tr><td align="left">2</td><td align="left">1</td><td align="left">request length</td></tr></tbody></table><table border="0"><colgroup><col align="left" class="c1" /><col align="left" class="c2" /><col align="left" class="c3" /></colgroup><thead><tr><th colspan="3" align="left">=&gt;</th></tr></thead><tbody><tr><td align="left">1</td><td align="left">1</td><td align="left">Reply</td></tr><tr><td align="left">1</td><td align="left"> </td><td align="left">unused</td></tr><tr><td align="left">2</td><td align="left">CARD16</td><td align="left">sequence number</td></tr><tr><td align="left">4</td><td align="left">0</td><td align="left">length</td></tr><tr><td align="left">4</td><td align="left">CARD32</td><td align="left">maximum-request-length</td></tr><tr><td align="left">2</td><td align="left">0</td><td align="left">unused</td></tr></tbody></table></div></div><div class="chapter" title="Chapter 5. C language binding"><div class="titlepage"><div><div><h2 class="title"><a id="C_Language_Binding"></a>Chapter 5. C language binding</h2></div></div></div><p>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary.  It is also desirable to make the use of this extension as transparent as possible to the X client.  For example, if enabling of the extension were delayed until the first time it was needed, an application that used
<span class="olink"><code class="function">XNextRequest</code></span>
to determine the sequence number of a request would no longer get the correct sequence number.  As such,
<span class="olink"><code class="function">XOpenDisplay</code></span>
will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</p><p>The core Xlib functions
<span class="olink"><code class="function">XDrawLines</code></span>,
<span class="olink"><code class="function">XDrawArcs</code></span>,
<span class="olink"><code class="function">XFillPolygon</code></span>,
<span class="olink"><code class="function">XChangeProperty</code></span>,
<span class="olink"><code class="function">XSetClipRectangles</code></span>, and
<span class="olink"><code class="function">XSetRegion</code></span>.
are required to use extended-length encodings when necessary, if supported by the server.  Use of extended-length encodings in other core Xlib functions
(<span class="olink"><code class="function">XDrawPoints</code></span>,
<span class="olink"><code class="function">XDrawRectangles</code></span>,
<span class="olink"><code class="function">XDrawSegments</code></span>.
<span class="olink"><code class="function">XFillArcs</code></span>,
<span class="olink"><code class="function">XFillRectangles</code></span>,
<span class="olink"><code class="function">XPutImage</code></span>
is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</p><p>To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib:

</p><div class="funcsynopsis"><a id="XExtendedMaxRequestSize"></a><p><code class="funcdef">long <strong>fsfuncXExtendedMaxRequestSize</strong>(</code>Display <var class="pdparam"> *display</var><code>)</code>;</p></div><p>

Returns zero (0) if the specified display does not support this extension, otherwise returns the maximum-request-length (in 4-byte units) supported by the server through the extended-length encoding.</p></div><div class="chapter" title="Chapter 6. Acknowledgements"><div class="titlepage"><div><div><h2 class="title"><a id="Acknowledgements"></a>Chapter 6. Acknowledgements</h2></div></div></div><p>Clive Feather (IXI) originated the extended-length encoding used in this extension proposal.</p></div></div></body></html>
x11proto-bigreqs-dev 1:1.1.2-1 / usr / share / doc / x11proto-bigreqs-dev / bigreq.html
