Skip to content

Latest commit

 

History

History
104 lines (77 loc) · 3.16 KB

Platforms.md

File metadata and controls

104 lines (77 loc) · 3.16 KB
Raw

Platforms docs

XQUIC currently supports Android , iOS , Linux and macOS .

Android/iOS Compile Script

The Android and iOS use .so files, there is a xqc_build.sh script in the XQUIC library directory, execute the script to compile to complete the corresponding compilation.

sh xqc_build.sh ios/android <build_dir> <artifact_dir> <ssl_path>

specially, <ssl_path> can be ${PWD}/third_party/boringssl or ${PWD}/third_party/babassl

Note: You need to specify the IOS/android build toolchain before compiling, download and set the environment variable IOS_CMAKE_TOOLCHAIN or ANDROID_NDK, or directly modify CMAKE_TOOLCHAIN_FILE in xqc_build.sh .

Linux Release

The default CMAKE_BUILD_TYPE is Release , so you only need to compile BoringSSL or BabaSSL, and then build XQUIC.

# build XQUIC with BabaSSL
git submodule update --init --recursive
mkdir build; cd build
cmake ..
make -j

# build XQUIC with BoringSSL
git submodule update --init --recursive
mkdir build; cd build
cmake -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} -DSSL_INC_PATH=${SSL_INC_PATH_STR} -DSSL_LIB_PATH=${SSL_LIB_PATH_STR} ..
make -j

macOS Release

You can use the cmake variables -DPLATFORM=mac to build XQUIC on macOS.

# build XQUIC with BabaSSL
git submodule update --init --recursive
mkdir build; cd build
cmake -DPLATFORM=mac ..
make -j

# build XQUIC with BoringSSL
git submodule update --init --recursive
mkdir build; cd build
cmake -DPLATFORM=mac -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} -DSSL_INC_PATH=${SSL_INC_PATH_STR} -DSSL_LIB_PATH=${SSL_LIB_PATH_STR} ..
make -j

Windows Release (beta)

xquic possible dependencies for Windows: Perl, Go, BoringSSL, libevent, set after installation to set the corresponding program PATH to the $PATH environment variable

VCPKG_DEFAULT_TRIPLET=x64-windows-static

#install libevent
vcpkg install libevent:x64-windows-static

build XQUIC

# step 1: get sourcecode
git clone [email protected]:alibaba/xquic.git
cd xquic
git submodule update --init --recursive

# step 2：build boringssl
git clone [email protected]:google/boringssl.git ./third_party/boringssl
cd ./third_party/boringssl
mkdir build
cd build

cmake  -DCMAKE_GENERATOR_PLATFORM=x64 --config Debug -DBUILD_SHARED_LIBS=0 -DCMAKE_C_FLAGS="-fPIC" -DCMAKE_CXX_FLAGS="-fPIC" ..

# build ssl && crypto
MSBuild.exe ALL_BUILD.vcxproj

cd ../../../

# step 3：build xquic
mkdir build
cd build
cmake -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} -DSSL_INC_PATH=${SSL_INC_PATH_STR} -DSSL_LIB_PATH=${SSL_LIB_PATH_STR} ..

MSBuild.exe xquic.vcxproj

# build demo && test
git clone https://github.com/alex85k/wingetopt.git third_party/wingetopt
#eg: cmake -DEVENT_LIB_DIR=D:/project/vcpkg/packages/libevent_x64-windows-static ..
cmake -DXQC_ENABLE_TESTING=1 -DEVENT_LIB_DIR=your_event_path ..

MSBuild.exe demo_client.vcxproj
MSBuild.exe demo_server.vcxproj
MSBuild.exe test_client.vcxproj
MSBuild.exe test_server.vcxproj