activemq-cpp-3.9.5
activemq::wireformat::stomp::StompHelper Class Reference

Utility Methods used when marshaling to and from StompFrame's. More...

#include <src/main/activemq/wireformat/stomp/StompHelper.h>

Public Member Functions

 StompHelper (StompWireFormat *wireFormat)
 
virtual ~StompHelper ()
 
void convertProperties (const Pointer< StompFrame > &frame, const Pointer< Message > &message)
 Converts the Headers in a Stomp Frame into Headers in the given Message Command.
 
void convertProperties (const Pointer< Message > &message, const Pointer< StompFrame > &frame)
 Converts the Properties in a Message Command to Valid Headers and Properties in the StompFrame.
 
Pointer< ActiveMQDestinationconvertDestination (const std::string &destination)
 Converts from a Stomp Destination to an ActiveMQDestination.
 
std::string convertDestination (const Pointer< ActiveMQDestination > &destination)
 Converts from a ActiveMQDestination to a Stomp Destination Name.
 
std::string convertMessageId (const Pointer< MessageId > &messageId)
 Converts a MessageId instance to a Stomp MessageId String.
 
Pointer< MessageIdconvertMessageId (const std::string &messageId)
 Converts a Stomp MessageId string to a MessageId.
 
std::string convertConsumerId (const Pointer< ConsumerId > &consumerId)
 Converts a ConsumerId instance to a Stomp ConsumerId String.
 
Pointer< ConsumerIdconvertConsumerId (const std::string &consumerId)
 Converts a Stomp ConsumerId string to a ConsumerId.
 
std::string convertProducerId (const Pointer< ProducerId > &producerId)
 Converts a ProducerId instance to a Stomp ProducerId String.
 
Pointer< ProducerIdconvertProducerId (const std::string &producerId)
 Converts a Stomp ProducerId string to a ProducerId.
 
std::string convertTransactionId (const Pointer< TransactionId > &transactionId)
 Converts a TransactionId instance to a Stomp TransactionId String.
 
Pointer< TransactionIdconvertTransactionId (const std::string &transactionId)
 Converts a Stomp TransactionId string to a TransactionId.
 

Detailed Description

Utility Methods used when marshaling to and from StompFrame's.

Since
3.0

Constructor & Destructor Documentation

◆ StompHelper()

activemq::wireformat::stomp::StompHelper::StompHelper ( StompWireFormat * wireFormat)

◆ ~StompHelper()

virtual activemq::wireformat::stomp::StompHelper::~StompHelper ( )
virtual

Member Function Documentation

◆ convertConsumerId() [1/2]

std::string activemq::wireformat::stomp::StompHelper::convertConsumerId ( const Pointer< ConsumerId > & consumerId)

Converts a ConsumerId instance to a Stomp ConsumerId String.

Parameters
consumerId- the Consumer instance to convert.
Returns
a Stomp Consumer Id String.

◆ convertConsumerId() [2/2]

Pointer< ConsumerId > activemq::wireformat::stomp::StompHelper::convertConsumerId ( const std::string & consumerId)

Converts a Stomp ConsumerId string to a ConsumerId.

Parameters
consumerId- the String Consumer Id to convert.
Returns
Pointer to a new ConsumerId.

◆ convertDestination() [1/2]

std::string activemq::wireformat::stomp::StompHelper::convertDestination ( const Pointer< ActiveMQDestination > & destination)

Converts from a ActiveMQDestination to a Stomp Destination Name.

Parameters
destination- The ActiveMQDestination to Convert
Returns
the Stomp String name that defines the destination.

◆ convertDestination() [2/2]

Pointer< ActiveMQDestination > activemq::wireformat::stomp::StompHelper::convertDestination ( const std::string & destination)

Converts from a Stomp Destination to an ActiveMQDestination.

Parameters
destination- The Stomp Destination name string.
Returns
Pointer to a new ActiveMQDestination.

◆ convertMessageId() [1/2]

std::string activemq::wireformat::stomp::StompHelper::convertMessageId ( const Pointer< MessageId > & messageId)

Converts a MessageId instance to a Stomp MessageId String.

Parameters
messageId- the MessageId instance to convert.
Returns
a Stomp Message Id String.

◆ convertMessageId() [2/2]

Pointer< MessageId > activemq::wireformat::stomp::StompHelper::convertMessageId ( const std::string & messageId)

Converts a Stomp MessageId string to a MessageId.

Parameters
messageId- the String message Id to convert.
Returns
Pointer to a new MessageId.

◆ convertProducerId() [1/2]

std::string activemq::wireformat::stomp::StompHelper::convertProducerId ( const Pointer< ProducerId > & producerId)

Converts a ProducerId instance to a Stomp ProducerId String.

Parameters
producerId- the Producer instance to convert.
Returns
a Stomp Producer Id String.

◆ convertProducerId() [2/2]

Pointer< ProducerId > activemq::wireformat::stomp::StompHelper::convertProducerId ( const std::string & producerId)

Converts a Stomp ProducerId string to a ProducerId.

Parameters
producerId- the String Producer Id to convert.
Returns
Pointer to a new ProducerId.

◆ convertProperties() [1/2]

void activemq::wireformat::stomp::StompHelper::convertProperties ( const Pointer< Message > & message,
const Pointer< StompFrame > & frame )

Converts the Properties in a Message Command to Valid Headers and Properties in the StompFrame.

Parameters
message- The message to move the Headers to.
frame- The frame to extract headers from.

◆ convertProperties() [2/2]

void activemq::wireformat::stomp::StompHelper::convertProperties ( const Pointer< StompFrame > & frame,
const Pointer< Message > & message )

Converts the Headers in a Stomp Frame into Headers in the given Message Command.

Parameters
frame- The frame to extract headers from.
message- The message to move the Headers to.

◆ convertTransactionId() [1/2]

std::string activemq::wireformat::stomp::StompHelper::convertTransactionId ( const Pointer< TransactionId > & transactionId)

Converts a TransactionId instance to a Stomp TransactionId String.

Parameters
transactionId- the Transaction instance to convert.
Returns
a Stomp Transaction Id String.

◆ convertTransactionId() [2/2]

Pointer< TransactionId > activemq::wireformat::stomp::StompHelper::convertTransactionId ( const std::string & transactionId)

Converts a Stomp TransactionId string to a TransactionId.

Parameters
transactionId- the String Transaction Id to convert.
Returns
Pointer to a new TransactionId.

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