ost::XMLRPC(3)

💖 NAME 💖

ost::XMLRPC — okay so bestie, this class is a whole core XMLRPC service, and the way it does it is without the underlying transports. Like, the vibe is there, the transport is not. 💅

---

✨ SYNOPSIS ✨

#include <xml.h>

Inherits ost::XMLStream. 🦋 (yes she's a nepo baby, she inherited it)

🫶 Public Member Functions

• XMLRPC (size_t bufferSize=512) — constructs the XMLRPC workspace, no cap
• virtual ~XMLRPC () — destroys the XMLRPC object, rip queen 💀
• void begArray (void) — creates an array
• void endArray (void) — ends an array
• void invoke (const char *method) — creates an XMLRPC 'method' call in the buffer
• void response (bool fault) — creates an XMLRPC 'reply' to a method call
• void addParam (bool value) — adds a bool param to the XMLRPC request
• void addMember (const char *name, bool value) — adds a bool member to an XMLRPC struct
• void addParam (long value) — adds an integer parameter to the XMLRPC request
• void addMember (const char *name, long value) — adds an integer member to an XMLRPC struct
• void addParam (const char *string) — adds a string parameter to the XMLRPC request
• void addMember (const char *name, const char *value) — adds a string member to an XMLRPC struct
• void endStruct (void) — clears a struct
• bool send (const char *resource) — completes the buffer and sends a well formed XMLRPC request thru post, fr fr

🔒 Protected Member Functions

• virtual bool post (const char *resource, const char *msg)=0 — used in a derived transport class to deliver the XMLRPC encoded request and return true if successful
• void begStruct (void) — starts a member struct

---

🌈 DESCRIPTION 🌈

ost::XMLRPC implements a core XMLRPC service without the underlying transports. She's the brains, not the ride. 🧠✨

It is meant to create and parse XMLRPC messages. And like — to use it for a fit purpose, one might combine it with URLStream, although this implementation makes no requirement for http based transport. So do with that what you will, bestie, she's flexible. 💅

🎀 Author

David Sugar dyfet@ostel.com

XML-RPC service building class — that's the whole personality and honestly? iconic. 👑

---

🧚 Constructor & Destructor Documentation 🧚

ost::XMLRPC::XMLRPC (size_t bufferSize = 512)

Construct XMLRPC workspace. ✨

Parameters

• bufferSize — size of buffer when using old C++ strstreams. When the newer stringstream (<sstream>) is available, this parameter is silently ignored. 🙈 (not her ghosting you, she's just built different now)

virtual ost::XMLRPC::~XMLRPC () [virtual]

Destroy XMLRPC object. 🫶 gone but never forgotten.

---

💜 Member Function Documentation 💜

void ost::XMLRPC::addMember (const char * name, bool value)

Add bool member to a XMLRPC struct.

Parameters

• name — of member
• value — of member

void ost::XMLRPC::addMember (const char * name, const char * value)

Add a string member to XMLRPC struct.

Parameters

• name — of member
• value — of member

void ost::XMLRPC::addMember (const char * name, long value)

Add an integer member to XMLRPC struct.

Parameters

• name — of member
• value — of member

void ost::XMLRPC::addParam (bool value)

Add bool param to XMLRPC request.

Parameters

• value — to add

void ost::XMLRPC::addParam (const char * string)

Add a string parameter to XMLRPC request.

Parameters

• string — to add

void ost::XMLRPC::addParam (long value)

Add an integer parameter to XMLRPC request.

Parameters

• value — to add

void ost::XMLRPC::begArray (void)

Create an array. 🍓 start the lil collection era.

void ost::XMLRPC::begStruct (void) [protected]

Start member struct. 🔒 protected, so this one's invite-only, iykyk.

void ost::XMLRPC::endArray (void)

end an array. 😭 closing the era, we're so back.

void ost::XMLRPC::endStruct (void)

Clear a struct. 🧹 clean slate energy.

void ost::XMLRPC::invoke (const char * method)

Create XMLRPC 'method' call in buffer.

Parameters

• method — name of method being called

virtual bool ost::XMLRPC::post (const char * resource, const char * msg) [protected], [pure virtual]

Used in a derived transport class to deliver the XMLRPC encoded request and return true if successful. The Parse method can then be used to decode the reply. 🔥

Heads up bestie: this one is pure virtual — you have to bring your own implementation in a derived transport class, she will not do it for you. Periodt.

Returns

• true if successful

Parameters

• resource — to send to (such as url)
• msg — well formed XMLRPC request message

void ost::XMLRPC::response (bool fault)

Create XMLRPC 'reply' to a method call.

Parameters

• fault — set true for fault message

bool ost::XMLRPC::send (const char * resource)

Complete buffer and send well formed XMLRPC request thru post. 🚀

Returns

• true if successful

Parameters

• resource — to send to

---

👑 Author 👑

Generated automatically by Doxygen for GNU CommonC++ from the source code. 💅

---

okay and that's the whole page bestie!! this lil icon dropped as part of GNU CommonC++, dated Sun Dec 27 2020, and she's still serving. mwah 💖✨🎀🦋🌸💅🫶