2019-09-06 19:34:01 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< link rel = "shortcut icon" href = "../img/favicon.ico" >
< title > Build - IXWebSocket< / title >
< link href = "../css/bootstrap-custom.min.css" rel = "stylesheet" >
< link href = "../css/font-awesome.min.css" rel = "stylesheet" >
< link href = "../css/base.css" rel = "stylesheet" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" >
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- [if lt IE 9]>
< script src = "https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js" > < / script >
< script src = "https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js" > < / script >
<![endif]-->
< script src = "../js/jquery-1.10.2.min.js" defer > < / script >
< script src = "../js/bootstrap-3.0.3.min.js" defer > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js" > < / script >
< script > hljs . initHighlightingOnLoad ( ) ; < / script >
< / head >
< body >
< div class = "navbar navbar-default navbar-fixed-top" role = "navigation" >
< div class = "container" >
<!-- Collapsed navigation -->
< div class = "navbar-header" >
<!-- Expander button -->
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = ".navbar-collapse" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = ".." > IXWebSocket< / a >
< / div >
<!-- Expanded navigation -->
< div class = "navbar-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
< li >
< a href = ".." > Home< / a >
< / li >
< li >
< a href = "../CHANGELOG/" > Changelog< / a >
< / li >
< li class = "active" >
< a href = "./" > Build< / a >
< / li >
2019-11-27 18:10:09 +01:00
< li >
< a href = "../cobra/" > Cobra< / a >
< / li >
2019-09-06 19:34:01 +02:00
< li >
< a href = "../design/" > Design< / a >
< / li >
< li >
< a href = "../usage/" > Examples< / a >
< / li >
< li >
< a href = "../ws/" > Ws< / a >
< / li >
< / ul >
< ul class = "nav navbar-nav navbar-right" >
< li >
< a href = "#" data-toggle = "modal" data-target = "#mkdocs_search_modal" >
< i class = "fa fa-search" > < / i > Search
< / a >
< / li >
< li >
< a rel = "next" href = "../CHANGELOG/" >
< i class = "fa fa-arrow-left" > < / i > Previous
< / a >
< / li >
< li >
2019-11-27 18:10:09 +01:00
< a rel = "prev" href = "../cobra/" >
2019-09-06 19:34:01 +02:00
Next < i class = "fa fa-arrow-right" > < / i >
< / a >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "container" >
< div class = "col-md-3" > < div class = "bs-sidebar hidden-print affix well" role = "complementary" >
< ul class = "nav bs-sidenav" >
< li class = "main active" > < a href = "#build" > Build< / a > < / li >
< li > < a href = "#cmake" > CMake< / a > < / li >
< li > < a href = "#vcpkg" > vcpkg< / a > < / li >
< li > < a href = "#conan" > Conan< / a > < / li >
< li > < a href = "#docker" > Docker< / a > < / li >
< / ul >
< / div > < / div >
< div class = "col-md-9" role = "main" >
< h2 id = "build" > Build< / h2 >
< h3 id = "cmake" > CMake< / h3 >
< p > CMakefiles for the library and the examples are available. This library has few dependencies, so it is possible to just add the source files into your project. Otherwise the usual way will suffice.< / p >
< pre > < code > mkdir build # make a build dir so that you can build out of tree.
cd build
cmake -DUSE_TLS=1 ..
make -j
make install # will install to /usr/local on Unix, on macOS it is a good idea to sudo chown -R `whoami`:staff /usr/local
< / code > < / pre >
< p > Headers and a static library will be installed to the target dir.
There is a unittest which can be executed by typing < code > make test< / code > .< / p >
< p > Options for building:< / p >
< ul >
< li > < code > -DUSE_TLS=1< / code > will enable TLS support< / li >
< li > < code > -DUSE_MBED_TLS=1< / code > will use < a href = "https://tls.mbed.org/" > mbedlts< / a > for the TLS support (default on Windows)< / li >
< li > < code > -DUSE_WS=1< / code > will build the ws interactive command line tool< / li >
< / ul >
2019-09-10 02:35:38 +02:00
< p > If you are on Windows, look at the < a href = "https://github.com/machinezone/IXWebSocket/blob/master/appveyor.yml" > appveyor< / a > file that has instructions for building dependencies.< / p >
2019-09-06 19:34:01 +02:00
< h3 id = "vcpkg" > vcpkg< / h3 >
< p > It is possible to get IXWebSocket through Microsoft < a href = "https://github.com/microsoft/vcpkg" > vcpkg< / a > .< / p >
< pre > < code > vcpkg install ixwebsocket
< / code > < / pre >
< h3 id = "conan" > Conan< / h3 >
2019-12-03 18:28:36 +01:00
< p > Support for building with conan was contributed by Olivia Zoe (thanks!). The package name to reference is < code > IXWebSocket/5.0.0@LunarWatcher/stable< / code > , and a list of the uploaded versions is available on < a href = "https://bintray.com/oliviazoe0/conan-packages/IXWebSocket%3ALunarWatcher" > Bintray< / a > . The package is in the process to be published to the official conan package repo, but in the meantime, it can be accessed by adding a new remote< / p >
2019-09-06 19:34:01 +02:00
< pre > < code > conan remote add remote_name_here https://api.bintray.com/conan/oliviazoe0/conan-packages
< / code > < / pre >
< h3 id = "docker" > Docker< / h3 >
< p > There is a Dockerfile for running the unittest on Linux, and to run the < code > ws< / code > tool. It is also available on the docker registry.< / p >
< pre > < code > docker run bsergean/ws
< / code > < / pre >
< p > To use docker-compose you must make a docker container first.< / p >
< pre > < code > $ make docker
...
$ docker compose up &
...
$ docker exec -it ixwebsocket_ws_1 bash
app@ca2340eb9106:~$ ws --help
ws is a websocket tool
...
< / code > < / pre > < / div >
< / div >
< footer class = "col-md-12" >
< hr >
< p > Documentation built with < a href = "https://www.mkdocs.org/" > MkDocs< / a > .< / p >
< / footer >
< script >
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
< / script >
< script src = "../js/base.js" defer > < / script >
< script src = "../search/main.js" defer > < / script >
< div class = "modal" id = "mkdocs_search_modal" tabindex = "-1" role = "dialog" aria-labelledby = "Search Modal" aria-hidden = "true" >
< div class = "modal-dialog" >
< div class = "modal-content" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" > < span aria-hidden = "true" > × < / span > < span class = "sr-only" > Close< / span > < / button >
< h4 class = "modal-title" id = "exampleModalLabel" > Search< / h4 >
< / div >
< div class = "modal-body" >
< p >
From here you can search these documents. Enter
your search terms below.
< / p >
< form role = "form" >
< div class = "form-group" >
< input type = "text" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" title = "Type search term here" >
< / div >
< / form >
< div id = "mkdocs-search-results" > < / div >
< / div >
< div class = "modal-footer" >
< / div >
< / div >
< / div >
< / div > < div class = "modal" id = "mkdocs_keyboard_modal" tabindex = "-1" role = "dialog" aria-labelledby = "Keyboard Shortcuts Modal" aria-hidden = "true" >
< div class = "modal-dialog" >
< div class = "modal-content" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" > < span aria-hidden = "true" > × < / span > < span class = "sr-only" > Close< / span > < / button >
< h4 class = "modal-title" id = "exampleModalLabel" > Keyboard Shortcuts< / h4 >
< / div >
< div class = "modal-body" >
< table class = "table" >
< thead >
< tr >
< th style = "width: 20%;" > Keys< / th >
< th > Action< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "help shortcut" > < kbd > ?< / kbd > < / td >
< td > Open this help< / td >
< / tr >
< tr >
< td class = "next shortcut" > < kbd > n< / kbd > < / td >
< td > Next page< / td >
< / tr >
< tr >
< td class = "prev shortcut" > < kbd > p< / kbd > < / td >
< td > Previous page< / td >
< / tr >
< tr >
< td class = "search shortcut" > < kbd > s< / kbd > < / td >
< td > Search< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "modal-footer" >
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
