activemq::connector::stomp::StompFrame Class Reference

#include <StompFrame.h>

List of all members.

Public Member Functions
	StompFrame (void)
virtual	~StompFrame (void)
virtual StompFrame *	clone (void) const
void	setCommand (const std::string &cmd)
const std::string &	getCommand (void) const
util::Properties &	getProperties (void)
const util::Properties &	getProperties (void) const
const char *	getBody (void) const
int	getBodyLength (void) const
void	setBody (const char *bytes, const int numBytes)
Private Attributes
std::string	command
util::SimpleProperties	properties
const char *	body
int	bodyLength

---

Detailed Description

A Stomp-level message frame that encloses all messages to and from the broker.

---

Constructor & Destructor Documentation

activemq::connector::stomp::StompFrame::StompFrame (  void   )  [inline]

Default constructor.

virtual activemq::connector::stomp::StompFrame::~StompFrame (  void   )  [inline, virtual]

Destruction - frees the memory pool.

---

Member Function Documentation

virtual StompFrame* activemq::connector::stomp::StompFrame::clone (  void   )  const [inline, virtual]

Clonse this message exactly, returns a new instance that the caller is required to delete. Returns: new copy of this message

const char* activemq::connector::stomp::StompFrame::getBody (  void   )  const [inline]

Accessor for the body data of this frame. Returns: char pointer to body data

int activemq::connector::stomp::StompFrame::getBodyLength (  void   )  const [inline]

Return the number of bytes contained in this frames body Returns: Body bytes length.

const std::string& activemq::connector::stomp::StompFrame::getCommand (  void   )  const [inline]

Accessor for this frame's command field.

const util::Properties& activemq::connector::stomp::StompFrame::getProperties (  void   )  const [inline]

util::Properties& activemq::connector::stomp::StompFrame::getProperties (  void   )  [inline]

Gets access to the header properties for this frame. Returns: the Properties object owned by this Frame

void activemq::connector::stomp::StompFrame::setBody (  const char *  bytes, const int  numBytes )  [inline]

Sets the body data of this frame as a byte sequence. Parameters: bytes  The byte buffer to be set in the body. numBytes  The number of bytes in the buffer.

void activemq::connector::stomp::StompFrame::setCommand (  const std::string &  cmd  )  [inline]

Sets the command for this stomp frame. Parameters: cmd  command The command to be set.

---

Member Data Documentation

const char* activemq::connector::stomp::StompFrame::body [private]

int activemq::connector::stomp::StompFrame::bodyLength [private]

std::string activemq::connector::stomp::StompFrame::command [private]

util::SimpleProperties activemq::connector::stomp::StompFrame::properties [private]

---

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

• activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h

---