12 #ifndef ZYPP_PLUGINFRAME_H
13 #define ZYPP_PLUGINFRAME_H
70 PluginFrame(
const std::string & command_r,
const std::string & body_r );
93 explicit operator bool()
const
98 const std::string &
command()
const;
103 void setCommand(
const std::string & command_r );
118 const std::string &
body()
const;
131 void setBody(
const std::string & body_r );
170 bool hasKey(
const std::string & key_r )
const
178 bool keySize(
const std::string & key_r )
const
194 const std::string &
getHeader(
const std::string & key_r )
const;
199 const std::string &
getHeader(
const std::string & key_r,
const std::string & default_r )
const;
202 const std::string &
getHeaderNT(
const std::string & key_r,
const std::string & default_r = std::string() )
const;
208 void setHeader(
const std::string & key_r,
const std::string & value_r = std::string() );
221 void addHeader(
const std::string & key_r,
const std::string & value_r = std::string() );
232 std::ostream &
writeTo( std::ostream & stream_r )
const;
236 {
return frame_r.
writeTo( stream_r ); }
242 { *
this =
PluginFrame( stream_r );
return stream_r; }
246 { frame_r =
PluginFrame( stream_r );
return stream_r; }
272 {
return( !
operator==( lhs, rhs ) ); }
277 #endif // ZYPP_PLUGINFRAME_H
bool keySize(const std::string &key_r) const
Return number of header entries for key_r.
friend bool operator==(const PluginFrame &lhs, const PluginFrame &rhs)
PluginFrame()
Default ctor (empty frame)
Command frame for communication with PluginScript.
void setCommand(const std::string &command_r)
Set the frame command.
const std::string & command() const
Return the frame command.
std::istream & operator>>(std::istream &str, PluginFrame &obj)
HeaderListIterator keyEnd(const std::string &key_r) const
Return iterator pointing behind the last header for key_r.
std::ostream & dumpOn(std::ostream &str, const PluginFrame &obj)
bool isEnomethodCommand() const
Convenience to identify an _ENOMETHOD command.
bool operator!=(const PluginFrame &lhs, const PluginFrame &rhs)
HeaderListIterator keyBegin(const std::string &key_r) const
Return iterator pointing to the 1st header for key_r (or keyEnd(key_r))
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.
bool isErrorCommand() const
Convenience to identify an ERROR command.
bool operator==(const SetRelation::Enum &lhs, const SetCompare &rhs)
static std::istream & readFrom(std::istream &stream_r, PluginFrame &frame_r)
static const std::string & errorCommand()
"ERROR" command.
void headerClear()
Clear the list of headers.
std::ostream & operator<<(std::ostream &str, const Exception &obj)
static const std::string & enomethodCommand()
"_ENOMETHOD" command.
bool keyEmpty(const std::string &key_r) const
unsigned headerSize() const
Return size of the header list.
Base class for PluginFrame Exception.
const std::initializer_list< std::pair< std::string, std::string > > & HeaderInitializerList
bool isAckCommand() const
Convenience to identify an ACK command.
friend std::ostream & operator<<(std::ostream &str, const PluginFrame &obj)
bool headerEmpty() const
Whether header list is empty.
static const std::string & ackCommand()
"ACK" command.
RWCOW_pointer< Impl > _pimpl
Pointer to implementation.
void setBody(const std::string &body_r)
Set the frame body.
HeaderListIterator headerEnd() const
Return iterator pointing behind the last header.
std::multimap< std::string, std::string > HeaderList
The header list.
void setHeader(HeaderInitializerList contents_r)
Set a new header list.
const std::string & getHeader(const std::string &key_r) const
Return header value for key_r.
bool hasKey(const std::string &key_r) const
Whether the header list contains at least one entry for key_r.
HeaderList::const_iterator HeaderListIterator
Header list iterator.
HeaderListIterator headerBegin() const
Return iterator pointing to the 1st header (or headerEnd)
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.
HeaderList & headerList()
Modifyalble header list for internal use only.
PluginFrame implementation.
std::ostream & writeTo(std::ostream &stream_r) const
Write frame to stream.
std::istream & readFrom(std::istream &stream_r)
Read frame from stream.
std::string & bodyRef()
Return a reference to the frame body.
bool empty() const
Whether this is an empty frame.
void clearHeader(const std::string &key_r)
Remove all headers for key_r.
static std::ostream & writeTo(std::ostream &stream_r, const PluginFrame &frame_r)
PluginFrameException Exception
Default exception type.
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.
const std::string & body() const
Return the frame body.