Represents a buffer for a single WebSocket message. More...

#include <message.hpp>

Public Types
typedef lib::shared_ptr< message >	ptr

typedef con_msg_manager< message >	con_msg_man_type

typedef con_msg_man_type::ptr	con_msg_man_ptr

typedef con_msg_man_type::weak_ptr	con_msg_man_weak_ptr

typedef con_msg_manager::weak_ptr	con_msg_man_ptr

Public Member Functions
	message (const con_msg_man_ptr manager)
	Construct an empty message.

	message (const con_msg_man_ptr manager, frame::opcode::value op, size_t size=128)
	Construct a message and fill in some values.

bool	get_prepared () const
	Return whether or not the message has been prepared for sending.

void	set_prepared (bool value)
	Set or clear the flag that indicates that the message has been prepared.

bool	get_compressed () const
	Return whether or not the message is flagged as compressed.

void	set_compressed (bool value)
	Set or clear the compression flag.

bool	get_terminal () const
	Get whether or not the message is terminal.

void	set_terminal (bool value)
	Set the terminal flag.

bool	get_fin () const
	Read the fin bit.

void	set_fin (bool value)
	Set the fin bit.

frame::opcode::value	get_opcode () const
	Return the message opcode.

void	set_opcode (frame::opcode::value op)
	Set the opcode.

std::string const &	get_header () const
	Return the prepared frame header.

void	set_header (std::string const &header)
	Set prepared frame header.

std::string const &	get_extension_data () const

std::string const &	get_payload () const
	Get a reference to the payload string.

std::string &	get_raw_payload ()
	Get a non-const reference to the payload string.

void	set_payload (std::string const &payload)
	Set payload data.

void	set_payload (void const *payload, size_t len)
	Set payload data.

void	append_payload (std::string const &payload)
	Append payload data.

void	append_payload (void const *payload, size_t len)
	Append payload data.

bool	recycle ()
	Recycle the message.

	message (con_msg_man_ptr manager, size_t size=128)

frame::opcode::value	get_opcode () const

const std::string &	get_header () const

const std::string &	get_extension_data () const

const std::string &	get_payload () const

bool	recycle ()
	Recycle the message.

Detailed Description

template<typename con_msg_manager>
class websocketpp::message_buffer::message< con_msg_manager >

Definition at line 101 of file pool.hpp.

Member Typedef Documentation

◆ con_msg_man_ptr [1/2]

template<typename con_msg_manager >

con_msg_man_type::ptr websocketpp::message_buffer::message< con_msg_manager >::con_msg_man_ptr

Definition at line 89 of file message.hpp.

◆ con_msg_man_ptr [2/2]

template<typename con_msg_manager >

con_msg_manager::weak_ptr websocketpp::message_buffer::message< con_msg_manager >::con_msg_man_ptr

Definition at line 105 of file pool.hpp.

◆ con_msg_man_type

template<typename con_msg_manager >

con_msg_manager<message> websocketpp::message_buffer::message< con_msg_manager >::con_msg_man_type

Definition at line 88 of file message.hpp.

◆ con_msg_man_weak_ptr

template<typename con_msg_manager >

con_msg_man_type::weak_ptr websocketpp::message_buffer::message< con_msg_manager >::con_msg_man_weak_ptr

Definition at line 90 of file message.hpp.

◆ ptr

template<typename con_msg_manager >

typedef lib::shared_ptr< message > websocketpp::message_buffer::message< con_msg_manager >::ptr

Definition at line 86 of file message.hpp.

Constructor & Destructor Documentation

◆ message() [1/3]

template<typename con_msg_manager >

websocketpp::message_buffer::message< con_msg_manager >::message ( const con_msg_man_ptr manager )

inline

Construct an empty message

Definition at line 96 of file message.hpp.

      : m_manager(manager)
      , m_prepared(false)
      , m_fin(true)
      , m_terminal(false)
      , m_compressed(false) {}

◆ message() [2/3]

template<typename con_msg_manager >

websocketpp::message_buffer::message< con_msg_manager >::message	(	const con_msg_man_ptr	manager,
		frame::opcode::value	op,
		size_t	size = 128 )

inline

Definition at line 107 of file message.hpp.

      : m_manager(manager)
      , m_opcode(op)
      , m_prepared(false)
      , m_fin(true)
      , m_terminal(false)
      , m_compressed(false)
    {
        m_payload.reserve(size);
    }

◆ message() [3/3]

template<typename con_msg_manager >

websocketpp::message_buffer::message< con_msg_manager >::message	(	con_msg_man_ptr	manager,
		size_t	size = 128 )

inline

Definition at line 107 of file pool.hpp.

108 : m_manager(manager)

109 , m_payload(size) {}

Member Function Documentation

◆ append_payload() [1/2]

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::append_payload ( std::string const & payload )

inline

Append data to the message buffer's payload.

Parameters

payload A string containing the data array to append.

Definition at line 287 of file message.hpp.

                                                   {
        m_payload.append(payload);
    }

◆ append_payload() [2/2]

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::append_payload	(	void const *	payload,
		size_t	len )

inline

Append data to the message buffer's payload.

Parameters

payload	A pointer to a data array to append
len	The length of payload in bytes

Definition at line 298 of file message.hpp.

                                                          {
        m_payload.reserve(m_payload.size()+len);
        m_payload.append(static_cast<char const *>(payload),len);
    }

◆ get_compressed()

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::get_compressed ( ) const

inline

Returns: whether or not the message is/should be compressed

Definition at line 143 of file message.hpp.

                                {
        return m_compressed;
    }

◆ get_extension_data() [1/2]

template<typename con_msg_manager >

std::string const & websocketpp::message_buffer::message< con_msg_manager >::get_extension_data ( ) const

inline

Definition at line 238 of file message.hpp.

                                                 {
        return m_extension_data;
    }

◆ get_extension_data() [2/2]

template<typename con_msg_manager >

const std::string & websocketpp::message_buffer::message< con_msg_manager >::get_extension_data ( ) const

inline

Definition at line 117 of file pool.hpp.

                                                {
        return m_extension_data;
    }

◆ get_fin()

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::get_fin ( ) const

inline

A message with the fin bit set will be sent as the last message of its sequence. A message with the fin bit cleared will require subsequent frames of opcode continuation until one of them has the fin bit set.

The remote end likely will not deliver any bytes until the frame with the fin bit set has been received.

Returns: Whether or not the fin bit is set

Definition at line 195 of file message.hpp.

                         {
        return m_fin;
    }

◆ get_header() [1/2]

template<typename con_msg_manager >

std::string const & websocketpp::message_buffer::message< con_msg_manager >::get_header ( ) const

inline

This value is typically set by a websocket protocol processor and shouldn't be tampered with.

Definition at line 224 of file message.hpp.

                                         {
        return m_header;
    }

◆ get_header() [2/2]

template<typename con_msg_manager >

const std::string & websocketpp::message_buffer::message< con_msg_manager >::get_header ( ) const

inline

Definition at line 114 of file pool.hpp.

                                        {
        return m_header;
    }

◆ get_opcode() [1/2]

template<typename con_msg_manager >

frame::opcode::value websocketpp::message_buffer::message< con_msg_manager >::get_opcode ( ) const

inline

Definition at line 210 of file message.hpp.

                                        {
        return m_opcode;
    }

◆ get_opcode() [2/2]

template<typename con_msg_manager >

frame::opcode::value websocketpp::message_buffer::message< con_msg_manager >::get_opcode ( ) const

inline

Definition at line 111 of file pool.hpp.

                                        {
        return m_opcode;
    }

◆ get_payload() [1/2]

template<typename con_msg_manager >

std::string const & websocketpp::message_buffer::message< con_msg_manager >::get_payload ( ) const

inline

Returns: A const reference to the message's payload string

Definition at line 246 of file message.hpp.

                                          {
        return m_payload;
    }

◆ get_payload() [2/2]

template<typename con_msg_manager >

const std::string & websocketpp::message_buffer::message< con_msg_manager >::get_payload ( ) const

inline

Definition at line 120 of file pool.hpp.

                                         {
        return m_payload;
    }

◆ get_prepared()

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::get_prepared ( ) const

inline

The prepared flag indicates that the message has been prepared by a websocket protocol processor and is ready to be written to the wire.

Returns: whether or not the message has been prepared for sending

Definition at line 125 of file message.hpp.

                              {
        return m_prepared;
    }

◆ get_raw_payload()

template<typename con_msg_manager >

std::string & websocketpp::message_buffer::message< con_msg_manager >::get_raw_payload ( )

inline

Returns: A reference to the message's payload string

Definition at line 254 of file message.hpp.

                                  {
        return m_payload;
    }

◆ get_terminal()

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::get_terminal ( ) const

inline

Messages can be flagged as terminal, which results in the connection being close after they are written rather than the implementation going on to the next message in the queue. This is typically used internally for close messages only.

Returns: Whether or not this message is marked terminal

Definition at line 169 of file message.hpp.

                              {
        return m_terminal;
    }

◆ recycle() [1/2]

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::recycle ( )

inline

A request to recycle this message was received. Forward that request to the connection message manager for processing. Errors and exceptions from the manager's recycle member function should be passed back up the call chain. The caller to message::recycle will deal with them.

Recycle must only be called by the message shared_ptr's destructor. Once recycled successfully, ownership of the memory has been passed to another system and must not be accessed again.

Returns: true if the message was successfully recycled, false otherwise.

Definition at line 316 of file message.hpp.

                   {
        con_msg_man_ptr shared = m_manager.lock();
 
        if (shared) {
            return shared->recycle(this);
        } else {
            return false;
        }
    }

◆ recycle() [2/2]

template<typename con_msg_manager >

bool websocketpp::message_buffer::message< con_msg_manager >::recycle ( )

inline

A request to recycle this message was received. Forward that request to the connection message manager for processing. Errors and exceptions from the manager's recycle member function should be passed back up the call chain. The caller to message::recycle will deal with them.

Recycle must only be called by the message shared_ptr's destructor. Once recycled successfully, ownership of the memory has been passed to another system and must not be accessed again.

Returns: true if the message was successfully recycled, false otherwise.

Definition at line 137 of file pool.hpp.

                   {
        typename con_msg_manager::ptr shared = m_manager.lock();
 
        if (shared) {
            return shared->(recycle(this));
        } else {
            return false;
        }
    }

◆ set_compressed()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_compressed ( bool value )

inline

Setting the compression flag indicates that the data in this message would benefit from compression. If both endpoints negotiate a compression extension WebSocket++ will attempt to compress messages with this flag. Setting this flag does not guarantee that the message will be compressed.

Parameters

value The value to set the compressed flag to

Definition at line 156 of file message.hpp.

                                    {
        m_compressed = value;
    }

◆ set_fin()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_fin ( bool value )

inline

See also: get_fin for a more detailed explaination of the fin bit

Parameters

value The value to set the fin bit to.

Definition at line 205 of file message.hpp.

                             {
        m_fin = value;
    }

◆ set_header()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_header ( std::string const & header )

inline

Under normal circumstances this should not be called by end users

Parameters

header A string to set the header to.

Definition at line 234 of file message.hpp.

                                              {
        m_header = header;
    }

◆ set_opcode()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_opcode ( frame::opcode::value op )

inline

Definition at line 215 of file message.hpp.

                                         {
        m_opcode = op;
    }

◆ set_payload() [1/2]

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_payload ( std::string const & payload )

inline

Set the message buffer's payload to the given value.

Parameters

payload A string to set the payload to.

Definition at line 264 of file message.hpp.

                                                {
        m_payload = payload;
    }

◆ set_payload() [2/2]

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_payload	(	void const *	payload,
		size_t	len )

inline

Set the message buffer's payload to the given value.

Parameters

payload	A pointer to a data array to set to.
len	The length of new payload in bytes.

Definition at line 275 of file message.hpp.

                                                       {
        m_payload.reserve(len);
        char const * pl = static_cast<char const *>(payload);
        m_payload.assign(pl, pl + len);
    }

◆ set_prepared()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_prepared ( bool value )

inline

This flag should not be set by end user code without a very good reason.

Parameters

value The value to set the prepared flag to

Definition at line 135 of file message.hpp.

                                  {
        m_prepared = value;
    }

◆ set_terminal()

template<typename con_msg_manager >

void websocketpp::message_buffer::message< con_msg_manager >::set_terminal ( bool value )

inline

This flag should not be set by end user code without a very good reason.

See also: get_terminal()

Parameters

value The value to set the terminal flag to.

Definition at line 181 of file message.hpp.

                                  {
        m_terminal = value;
    }

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

libraries/fc/vendor/websocketpp/websocketpp/message_buffer/message.hpp
libraries/fc/vendor/websocketpp/websocketpp/message_buffer/pool.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ con_msg_man_ptr [1/2]

◆ con_msg_man_ptr [2/2]

◆ con_msg_man_type

◆ con_msg_man_weak_ptr

◆ ptr

Constructor & Destructor Documentation

◆ message() [1/3]

◆ message() [2/3]

◆ message() [3/3]

Member Function Documentation

◆ append_payload() [1/2]

◆ append_payload() [2/2]

◆ get_compressed()

◆ get_extension_data() [1/2]

◆ get_extension_data() [2/2]

◆ get_fin()

◆ get_header() [1/2]

◆ get_header() [2/2]

◆ get_opcode() [1/2]

◆ get_opcode() [2/2]

◆ get_payload() [1/2]

◆ get_payload() [2/2]

◆ get_prepared()

◆ get_raw_payload()

◆ get_terminal()

◆ recycle() [1/2]

◆ recycle() [2/2]

◆ set_compressed()

◆ set_fin()

◆ set_header()

◆ set_opcode()

◆ set_payload() [1/2]

◆ set_payload() [2/2]

◆ set_prepared()

◆ set_terminal()