oatpp-websocket/1.3.0

WebSocket functionality for oatpp applications
Recipe info
2022-10-15

Install
Add the following line to your conanfile.txt:
[requires]
oatpp-websocket/1.3.0

Using oatpp-websocket

Note

If you are a new Conan user, we recommend reading the how to consume packages tutorial.

If you need additional assistance, please ask a question in the Conan Center Index repository.

Simplest use case consuming this recipe and assuming CMake as your local build tool:

[requires]
oatpp-websocket/1.3.0
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
from conan import ConanFile
from conan.tools.cmake import cmake_layout


class ExampleRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def requirements(self):
        self.requires("oatpp-websocket/1.3.0")

    def layout(self):
        cmake_layout(self)

Now, you can run this Conan command to locally install (and build if necessary) this recipe and its dependencies (if any):

$ conan install conanfile.txt --build=missing

Useful information to take into account to consume this library:


These are the main declared targets:

  • CMake package name(s): oatpp-websocket
  • CMake target name(s): oatpp::oatpp-websocket
  • _oatpp-websocket => oatpp::oatpp-websocket
    
  • pkg-config file name(s): oatpp-websocket.pc
  • _oatpp-websocket => oatpp-websocket-_oatpp-websocket.pc
    

A simple use case using the CMake file name and the global target:

# ...
find_package(oatpp-websocket REQUIRED)
# ...
target_link_libraries(YOUR_TARGET oatpp::oatpp-websocket)

These are all the available headers. Some of these ones might be non-public; make sure of it by visiting the oatpp-websocket homepage listed above:

#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/AsyncConnectionHandler.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/AsyncWebSocket.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/Config.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/ConnectionHandler.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/Connector.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/Frame.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/Handshaker.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/SHA1.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/Utils.hpp"
#include "oatpp-1.3.0/oatpp-websocket/oatpp-websocket/WebSocket.hpp"