websocketpp::extensions::permessage_deflate::disabled< config > Class Template Reference

Stub class for use when disabling permessage_deflate extension. More...

#include <disabled.hpp>

Public Member Functions
err_str_pair	negotiate (http::attribute_list const &)
	Negotiate extension.
lib::error_code	init (bool)
	Initialize state.
bool	is_implemented () const
bool	is_enabled () const
std::string	generate_offer () const
	Generate extension offer.
lib::error_code	compress (std::string const &, std::string &)
	Compress bytes.
lib::error_code	decompress (uint8_t const *, size_t, std::string &)
	Decompress bytes.

Detailed Description

template<typename config>
class websocketpp::extensions::permessage_deflate::disabled< config >

This class is a stub that implements the permessage_deflate interface with minimal dependencies. It is used to disable permessage_deflate functionality at compile time without loading any unnecessary code.

Definition at line 52 of file disabled.hpp.

Member Function Documentation

compress()

template<typename config >

lib::error_code websocketpp::extensions::permessage_deflate::disabled< config >::compress ( std::string const & , std::string &  )

inline

Parameters

[in]	in	String to compress
[out]	out	String to append compressed bytes to

Returns

Error or status code

Definition at line 108 of file disabled.hpp.

                                                           {
        return make_error_code(error::disabled);
    }

decompress()

template<typename config >

lib::error_code websocketpp::extensions::permessage_deflate::disabled< config >::decompress ( uint8_t const * , size_t , std::string &  )

inline

Parameters

buf	Byte buffer to decompress
len	Length of buf
out	String to append decompressed bytes to

Returns

Error or status code

Definition at line 119 of file disabled.hpp.

                                                                   {
        return make_error_code(error::disabled);
    }

generate_offer()

template<typename config >

std::string websocketpp::extensions::permessage_deflate::disabled< config >::generate_offer ( ) const

inline

Creates an offer string to include in the Sec-WebSocket-Extensions header of outgoing client requests.

Returns

A WebSocket extension offer string for this extension

Definition at line 98 of file disabled.hpp.

                                     {
        return "";
    }

init()

template<typename config >

lib::error_code websocketpp::extensions::permessage_deflate::disabled< config >::init ( bool )

inline

For the disabled extension state initialization is a no-op.

Parameters

is_server

True to initialize as a server, false for a client.

Returns

A code representing the error that occurred, if any

Definition at line 75 of file disabled.hpp.

                             {
        return lib::error_code();
    }

is_enabled()

template<typename config >

bool websocketpp::extensions::permessage_deflate::disabled< config >::is_enabled ( ) const

inline

Returns true if permessage_deflate functionality is active for this connection

Definition at line 87 of file disabled.hpp.

                            {
        return false;
    }

Here is the caller graph for this function:

is_implemented()

template<typename config >

bool websocketpp::extensions::permessage_deflate::disabled< config >::is_implemented ( ) const

inline

Returns true if the extension is capable of providing permessage_deflate functionality

Definition at line 81 of file disabled.hpp.

                                {
        return false;
    }

Here is the caller graph for this function:

negotiate()

template<typename config >

err_str_pair websocketpp::extensions::permessage_deflate::disabled< config >::negotiate ( http::attribute_list const & )

inline

The disabled extension always fails the negotiation with a disabled error.

Parameters

offer

Attribute from client's offer

Returns

Status code and value to return to remote endpoint

Definition at line 64 of file disabled.hpp.

                                                       {
        return make_pair(make_error_code(error::disabled),std::string());
    }

---

The documentation for this class was generated from the following file:

• libraries/fc/vendor/websocketpp/websocketpp/extensions/permessage_deflate/disabled.hpp