Boost C++ Libraries

PrevUpHomeNext

Struct cookie_arg

boost::taar::handler::cookie_arg — Argument provider that reads a cookie value by name.

Synopsis

// In header: <boost/taar/handler/rest_arg.hpp>


struct cookie_arg {

  // public member functions
  cookie_arg(std::string, std::string = {});
  std::string const & name() const;
  std::string const & description() const;
  taar::result< std::string > 
  operator()(boost::beast::http::request_header<> const &, 
             matcher::context const &) const;

  // public data members
  std::string name_;
  std::string description_;
};

Description

Parses each Cookie header on the request and returns the value associated with name. Reports error::argument_not_found if no cookie with that name is present.

cookie_arg public member functions

  1. cookie_arg(std::string name, std::string description = {});
  2. std::string const & name() const;
  3. std::string const & description() const;
  4. taar::result< std::string > 
    operator()(boost::beast::http::request_header<> const & request, 
               matcher::context const &) const;

PrevUpHomeNext