Protocol Class Reference

#include <Protocol.hpp>

Inherits NonInstantiable< Protocol >.

Classes
class	Tags

Static Public Member Functions
static XmlNode	goto_doc_node (const XmlNode &node)
static XmlNode	first_frame_node (const XmlNode &node)
static XmlNode	add_signal_frame (XmlNode &node, const std::string &target, const URI &sender, const URI &receiver, bool user_transaction)
static XmlNode	add_reply_frame (XmlNode &node)
static boost::shared_ptr< XmlDoc >	create_doc ()

Detailed Description

Provides functions for basic XML protocol manipulations.

Author

Tiago Quintino (initial author)

Quentin Gasper

Definition at line 26 of file Protocol.hpp.

Member Function Documentation

XmlNode add_reply_frame ( XmlNode &  node )

static

Adds a reply frame parallel to the XmlNode passed. It will set automatically the type attrribute. It will try to set the receiver and the target from the signal to which it is answering.

Parameters

node	Signal frame node to which a reply has to added.

Returns

Returns the new reply frame node.

Definition at line 135 of file Protocol.cpp.

XmlNode add_signal_frame ( XmlNode &  node, const std::string &  target, const URI &  sender, const URI &  receiver, bool  user_transaction  )

static

Adds a signal frame within the XmlNode passed ( typically a doc ). It will set automatically the type attribute.

Parameters

node	The node in which to add the new frame.
target	The target (signal name).
sender	Path to the sender component.
receiver	Path to the receiver component.
user_transaction	If true, the signal was initiated from a user transaction.

Returns

Returns the new signal frame node.

Definition at line 114 of file Protocol.cpp.

boost::shared_ptr< XmlDoc > create_doc ( )

static

Creates a new XmlDoc.

Returns

Returns a shared pointer with the new document.

Definition at line 177 of file Protocol.cpp.

XmlNode first_frame_node ( const XmlNode &  node )

static

Searches for a frame node.

Parameters

node	Node under which to search.

Returns

The first frame node inside a doc node, or a invalid node if no frame was found.

Definition at line 105 of file Protocol.cpp.

XmlNode goto_doc_node ( const XmlNode &  node )

static

Searches for a document node after the XML declaration.

Parameters

The	node under which to search.

Returns

The first node not part of the XML declaration.

Exceptions

XmlError

If a such node was not found.

Definition at line 72 of file Protocol.cpp.

---

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

• cf3/common/XML/Protocol.hpp
• cf3/common/XML/Protocol.cpp