rfc6455.hpp

Go to the documentation of this file.

//
// Copyright (c) 2016-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/beast
//

#ifndef BOOST_BEAST_WEBSOCKET_RFC6455_HPP
#define BOOST_BEAST_WEBSOCKET_RFC6455_HPP

#include <boost/beast/config.hpp>
#include <boost/beast/core/static_string.hpp>
#include <boost/beast/core/string.hpp>
#include <boost/beast/http/message.hpp>
#include <array>
#include <cstdint>

namespace boost {
namespace beast {
namespace websocket {

template<class Allocator>
bool
is_upgrade(beast::http::header<true,
    http::basic_fields<Allocator>> const& req);

enum close_code : std::uint16_t
{
    normal          = 1000,

    going_away      = 1001,

    protocol_error  = 1002,

    unknown_data    = 1003,

    bad_payload     = 1007,

    policy_error    = 1008,

    too_big         = 1009,

    needs_extension = 1010,

    internal_error  = 1011,

    service_restart = 1012,

    try_again_later = 1013,

    //----
    //
    // The following are illegal on the wire
    //

    none            = 0,

    reserved1       = 1004,

    no_status       = 1005,

    abnormal        = 1006,

    reserved2       = 1014,

    reserved3       = 1015

    //
    //----

    //last = 5000 // satisfy warnings
};

using reason_string = static_string<123, char>;

using ping_data = static_string<125, char>;

struct close_reason
{
    std::uint16_t code = close_code::none;

    reason_string reason;

    close_reason() = default;

    close_reason(std::uint16_t code_)
        : code(code_)
    {
    }

    close_reason(string_view s)
        : code(close_code::normal)
        , reason(s)
    {
    }

    close_reason(char const* s)
        : code(close_code::normal)
        , reason(s)
    {
    }

    close_reason(close_code code_, string_view s)
        : code(code_)
        , reason(s)
    {
    }

    operator bool() const
    {
        return code != close_code::none;
    }
};

} // websocket
} // beast
} // boost

#include <boost/beast/websocket/impl/rfc6455.ipp>

#endif