Go to file
Frediano Ziglio 55dd7410b0 sys-socket: Introduce some utility to make sockets more portable
Between Unix and Windows socket are quite different:
- on Windows sockets have a different namespace from C file
  descriptors so you can't use read/write/close or similar functions;
- errors are not stored in errno but you must be read/write the
  errors with specific function;
- sometimes sockets are put in non-blocking mode automatically
  calling some functions;
- SOCKET type is 64 bit on Windows 64 which does not fit technically
  in an int. Is however safe to assume them to fit in an int.

So encapsulate the socket APIs in some definition to make easier
and more safe to deal with them.
Where the portability to Windows would make to code more offuscated a Unix
style was preferred. For instance if errors are detected errno is set from
Windows socket error instead of changing all code handling.
Fortunately on Windows Qemu core interface accepts socket (but not
other types like C file descriptors!).

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
2019-05-07 10:14:00 +01:00
build-aux Add support for building with meson/ninja 2018-08-30 11:10:45 -03:00
docs Do not check for HAVE_CONFIG_H 2019-04-30 09:26:55 +01:00
m4 m4: Remove repeated warnings suppression 2019-02-01 08:48:08 +00:00
server sys-socket: Introduce some utility to make sockets more portable 2019-05-07 10:14:00 +01:00
subprojects Fix meson build importing spice-common fix 2019-04-05 17:12:37 +01:00
tests tests/migrate.py: add --vdagent 2011-08-23 17:01:14 +03:00
tools reds_stat: Use EXIT_SUCCESS/EXIT_FAILURE for program result 2018-12-23 17:04:01 +00:00
uncrustify_cfg fresh start 2009-10-14 15:06:41 +02:00
.gitignore docs: Add some documentation on spice threading model 2017-09-11 18:03:57 +01:00
.gitlab-ci.yml gitlab-ci: build out-of-tree too 2019-05-01 19:38:09 +01:00
.gitmodules build: Move spice-common to subprojects/ directory 2018-07-23 14:49:19 -03:00
.mailmap syntax-check: Fix missing AUTHORS 2016-12-05 13:48:28 +00:00
.travis.yml Add travis CI file 2015-11-27 20:21:24 +01:00
AUTHORS inputs-channel: Attempt to have a reliable led state 2019-04-30 09:05:07 +01:00
autogen.sh build-sys: Pass --enable-python-checks when running autogen.sh 2015-04-23 10:38:24 +02:00
cfg.mk Do not check for HAVE_CONFIG_H 2019-04-30 09:26:55 +01:00
ChangeLog fresh start 2009-10-14 15:06:41 +02:00
configure.ac build: Detect Windows build and change some definitions 2019-05-07 10:13:48 +01:00
COPYING Relicense everything from GPL to LGPL 2.1+ 2010-04-13 22:22:15 +02:00
GNUmakefile syntax-check: Update gnufiles 2016-11-18 12:06:53 +00:00
maint.mk syntax-check: Update gnufiles 2016-11-18 12:06:53 +00:00
Makefile.am Add support for building with meson/ninja 2018-08-30 11:10:45 -03:00
meson_options.txt meson: switch smartcard option to auto feature 2019-02-13 17:00:07 +00:00
meson.build build: Detect Windows build and change some definitions 2019-05-07 10:13:48 +01:00
NEWS build: Prepare for 0.14.2 release 2019-04-30 09:05:07 +01:00
README Update spice-protocol version 2019-04-26 11:45:12 +01:00
spice-server.pc.in build-sys: Require a new enough spice-protocol in .pc file 2015-08-26 11:01:09 +02:00
TODO.multiclient Remove trailing whitespace from end of lines 2012-01-13 18:11:59 +02:00

   SPICE: Simple Protocol for Independent Computing Environments
   =============================================================

SPICE is a remote display system built for virtual environments which
allows you to view a computing 'desktop' environment not only on the
machine where it is running, but from anywhere on the Internet and
from a wide variety of machine architectures.

Installation
------------

The SPICE package uses GNU autotools, so the build install process
follows the standard process documented in the INSTALL file. As a
quick start you can do

  ./configure --prefix=/usr --sysconfdir=/etc \
        --localstatedir=/var --libdir=/usr/lib
  make
  sudo make install

Or to install into a private user specific location

  ./configure --prefix=$HOME/spice
  make
  make install

The following mandatory dependencies are required in order to
build SPICE

    Spice protocol >= 0.14.0
    Pixman         >= 0.17.7
    OpenSSL
    libjpeg
    zlib

The following optional dependencies increase the available
functionality

    Cyrus-SASL
    libcacard      >= 2.5.1             (Smartcard support)
    Opus           >= 1.0.0             (Opus audio encoding support)
    LZ4                                 (LZ4 compression support)
    GStreamer      >= 1.0.0

Communication
-------------

To communicate with the development team, or to post patches
there is a technical mailing list:

   http://lists.freedesktop.org/mailman/listinfo/spice-devel

There is also a mailing list for new release announcements:

   http://lists.freedesktop.org/archives/spice-announce/

To view known bugs, or report new bugs, in SPICE visit

   https://gitlab.freedesktop.org/spice/spice/issues/new?

Bugs found when using an OS distribution's binary packages should
be reported to the OS vendors' own bug tracker first.

The latest SPICE code can be found in GIT at:

   https://gitlab.freedesktop.org/spice/

Licensing
---------

SPICE is provided under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

Please see the COPYING file for the complete LGPLv2+ license
terms, or visit <http://www.gnu.org/licenses/>.

Experimental Features
---------------------
To enable multiple client connections, set:
SPICE_DEBUG_ALLOW_MC=1

-- End of readme