Command frame for communication with PluginScript. More...

#include <zypp-core/rpc/PluginFrame.h>

Classes
struct	Impl
	PluginFrame implementation. More...

Public Types
using	Exception = PluginFrameException
	Default exception type.
using	HeaderList = std::multimap<std::string, std::string>
	The header list.
using	HeaderListIterator = HeaderList::const_iterator
	Header list iterator.

Public Member Functions
	PluginFrame ()
	Default ctor (empty frame)
	PluginFrame (const std::string &command_r)
	Ctor taking the command.
	PluginFrame (const std::string &command_r, std::string body_r)
	Ctor taking command and body.
	PluginFrame (const std::string &command_r, ByteArray body_r)
	Ctor taking command and body.
	PluginFrame (const std::string &command_r, HeaderInitializerList contents_r)
	Ctor taking the command and a HeaderInitializerList.
	PluginFrame (const std::string &command_r, ByteArray body_r, HeaderInitializerList contents_r)
	Ctor taking command, body and a HeaderInitializerList.
	PluginFrame (std::istream &stream_r)
	Ctor reading frame data from a stream.
bool	empty () const
	Whether this is an empty frame.
	operator bool () const
	Evaluate in a boolean context (not an empty frame)
const std::string &	command () const
	Return the frame command.
void	setCommand (const std::string &command_r)
	Set the frame command.
bool	isAckCommand () const
	Convenience to identify an ACK command.
bool	isErrorCommand () const
	Convenience to identify an ERROR command.
bool	isEnomethodCommand () const
	Convenience to identify an _ENOMETHOD command.
const ByteArray &	body () const
	Return the frame body.
ByteArray &	bodyRef ()
	Return a reference to the frame body.
void	setBody (const std::string &body_r)
	Set the frame body.
void	setBody (const ByteArray &body_r)
	Set the frame body.
void	setBody (ByteArray &&body_r)
	Set the frame body.
const HeaderList &	headerList () const
	The header list.
bool	headerEmpty () const
	Whether header list is empty.
unsigned	headerSize () const
	Return size of the header list.
HeaderListIterator	headerBegin () const
	Return iterator pointing to the 1st header (or headerEnd)
HeaderListIterator	headerEnd () const
	Return iterator pointing behind the last header.
void	headerClear ()
	Clear the list of headers.
bool	hasKey (const std::string &key_r) const
	Whether the header list contains at least one entry for `key_r`.
bool	keyEmpty (const std::string &key_r) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	keySize (const std::string &key_r) const
	Return number of header entries for `key_r`.
HeaderListIterator	keyBegin (const std::string &key_r) const
	Return iterator pointing to the 1st header for `key_r` (or keyEnd(key_r))
HeaderListIterator	keyEnd (const std::string &key_r) const
	Return iterator pointing behind the last header for `key_r`.
const std::string &	getHeader (const std::string &key_r) const
	Return header value for `key_r`.
const std::string &	getHeader (const std::string &key_r, const std::string &default_r) const
	Return header value for `key_r` or `default_r` if it does not exist.
const std::string &	getHeaderNT (const std::string &key_r, const std::string &default_r=std::string()) const
	Not throwing version returing one of the matching header values or `default_r` string.
void	setHeader (const std::string &key_r, const std::string &value_r=std::string())
	Set header for `key_r` removing all other occurrences of `key_r`.
void	setHeader (HeaderInitializerList contents_r)
	Set a new header list.
void	addHeader (const std::string &key_r, const std::string &value_r=std::string())
	Add header for `key_r` leaving already existing headers for `key_r` unchanged.
void	addHeader (HeaderInitializerList contents_r)
void	addRawHeader (const ByteArray &header)
void	clearHeader (const std::string &key_r)
	Remove all headers for `key_r`.
std::ostream &	writeTo (std::ostream &stream_r) const
	Write frame to stream.
std::istream &	readFrom (std::istream &stream_r)
	Read frame from stream.

Static Public Member Functions
static const std::string &	ackCommand ()
	"ACK" command.
static const std::string &	errorCommand ()
	"ERROR" command.
static const std::string &	enomethodCommand ()
	"_ENOMETHOD" command.
static const std::string &	contentLengthHeader ()
	"content-lenght" header name
static std::ostream &	writeTo (std::ostream &stream_r, const PluginFrame &frame_r)
static std::istream &	readFrom (std::istream &stream_r, PluginFrame &frame_r)

Private Types
using	HeaderInitializerList = const std::initializer_list<std::pair<std::string, std::string>> &

Private Member Functions
HeaderList &	headerList ()
	Modifyalble header list for internal use only.

Private Attributes
RWCOW_pointer< Impl >	_pimpl
	Pointer to implementation.

Friends
std::ostream &	operator<< (std::ostream &str, const PluginFrame &obj)
bool	operator== (const PluginFrame &lhs, const PluginFrame &rhs)

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &str, const PluginFrame::Impl &obj)
	Stream output.
std::ostream &	operator<< (std::ostream &str, const PluginFrame &obj)
	Stream output for logging.
std::ostream &	dumpOn (std::ostream &str, const PluginFrame &obj)
	Stream output writing all data for logging (no throw)
std::istream &	operator>> (std::istream &str, PluginFrame &obj)
	Construct from stream.
bool	operator== (const PluginFrame &lhs, const PluginFrame &rhs)
	Comparison based on content.
bool	operator!= (const PluginFrame &lhs, const PluginFrame &rhs)
	Comparison based on content.

Detailed Description

Command frame for communication with PluginScript.

COMMAND
key:value header lines
 
multiline body separated from header
by an empty line and terminated by NUL.
^@

See also: PluginScript

Definition at line 41 of file PluginFrame.h.

Member Typedef Documentation

◆ HeaderInitializerList

using zypp::PluginFrame::HeaderInitializerList = const std::initializer_list<std::pair<std::string, std::string>> &

private

Definition at line 46 of file PluginFrame.h.

◆ Exception

using zypp::PluginFrame::Exception = PluginFrameException

Default exception type.

Definition at line 60 of file PluginFrame.h.

◆ HeaderList

using zypp::PluginFrame::HeaderList = std::multimap<std::string, std::string>

The header list.

Definition at line 149 of file PluginFrame.h.

◆ HeaderListIterator

using zypp::PluginFrame::HeaderListIterator = HeaderList::const_iterator

Header list iterator.

Definition at line 152 of file PluginFrame.h.

Constructor & Destructor Documentation

◆ PluginFrame() [1/7]

zypp::PluginFrame::PluginFrame ( )

Default ctor (empty frame)

Definition at line 408 of file PluginFrame.cc.