pulp::runtime::MemoryMessageChannel Class Reference

#include <memory_message_channel.hpp>

Public Member Functions
	~MemoryMessageChannel () override
bool	send (const std::uint8_t *data, std::size_t size) override
	Send a message.
bool	send_text (std::string_view text) override
void	on_message (MessageCallback callback) override
	Install / replace callbacks.
void	on_closed (ChannelClosedCallback callback) override
void	on_error (ChannelErrorCallback callback) override
void	close () override
	Close the channel. Idempotent. Fires the closed callback.
bool	is_open () const override
	Whether the channel is currently usable.
bool	send (std::string_view text)

Static Public Member Functions
static std::pair< std::unique_ptr< MemoryMessageChannel >, std::unique_ptr< MemoryMessageChannel > >	make_pair ()
	Create a connected pair.

Constructor & Destructor Documentation

~MemoryMessageChannel()

pulp::runtime::MemoryMessageChannel::~MemoryMessageChannel ( )

override

Member Function Documentation

close()

void pulp::runtime::MemoryMessageChannel::close ( )

overridevirtual

Close the channel. Idempotent. Fires the closed callback.

Implements pulp::runtime::MessageChannel.

is_open()

bool pulp::runtime::MemoryMessageChannel::is_open ( ) const

inlineoverridevirtual

Whether the channel is currently usable.

Implements pulp::runtime::MessageChannel.

make_pair()

std::pair< std::unique_ptr< MemoryMessageChannel >, std::unique_ptr< MemoryMessageChannel > > pulp::runtime::MemoryMessageChannel::make_pair ( )

static

Create a connected pair.

Each side delivers sends to the other's on_message.

on_closed()

void pulp::runtime::MemoryMessageChannel::on_closed ( ChannelClosedCallback callback )

overridevirtual

Implements pulp::runtime::MessageChannel.

on_error()

void pulp::runtime::MemoryMessageChannel::on_error ( ChannelErrorCallback callback )

overridevirtual

Implements pulp::runtime::MessageChannel.

on_message()

void pulp::runtime::MemoryMessageChannel::on_message ( MessageCallback callback )

overridevirtual

Install / replace callbacks.

Safe to call at any time; callbacks installed during send-processing apply to subsequent messages.

Implements pulp::runtime::MessageChannel.

send() [1/2]

bool pulp::runtime::MemoryMessageChannel::send ( const std::uint8_t * data, std::size_t size )

overridevirtual

Send a message.

Returns true if the payload was accepted for transmission (queued or written); false if the channel is closed, errored, or the payload was rejected (e.g., frame too large).

The default overload sends binary; override send_text if the transport distinguishes text from binary.

Implements pulp::runtime::MessageChannel.

send() [2/2]

bool pulp::runtime::MessageChannel::send ( std::string_view text )

inlineinherited

send_text()

bool pulp::runtime::MemoryMessageChannel::send_text ( std::string_view text )

overridevirtual

Reimplemented from pulp::runtime::MessageChannel.

---

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

• /home/runner/work/pulp/pulp/core/runtime/include/pulp/runtime/memory_message_channel.hpp