activemq-cpp-3.9.0
activemq::core::ActiveMQXAConnectionFactory Class Reference

#include <src/main/activemq/core/ActiveMQXAConnectionFactory.h>

Inheritance diagram for activemq::core::ActiveMQXAConnectionFactory:

Public Member Functions

 ActiveMQXAConnectionFactory ()
 
 ActiveMQXAConnectionFactory (const std::string &uri, const std::string &username="", const std::string &password="")
 Constructor. More...
 
 ActiveMQXAConnectionFactory (const decaf::net::URI &uri, const std::string &username="", const std::string &password="")
 Constructor. More...
 
virtual ~ActiveMQXAConnectionFactory ()
 
virtual cms::XAConnectioncreateXAConnection ()
 Creates an XAConnection with the default user name and password. More...
 
virtual cms::XAConnectioncreateXAConnection (const std::string &userName, const std::string &password)
 Creates an XA connection with the specified user name and password. More...
 
- Public Member Functions inherited from cms::XAConnectionFactory
virtual ~XAConnectionFactory ()
 
- Public Member Functions inherited from activemq::core::ActiveMQConnectionFactory
 ActiveMQConnectionFactory ()
 
 ActiveMQConnectionFactory (const std::string &uri, const std::string &username="", const std::string &password="")
 Constructor. More...
 
 ActiveMQConnectionFactory (const decaf::net::URI &uri, const std::string &username="", const std::string &password="")
 Constructor. More...
 
virtual ~ActiveMQConnectionFactory ()
 
virtual cms::ConnectioncreateConnection ()
 Creates a connection with the default user identity. More...
 
virtual cms::ConnectioncreateConnection (const std::string &username, const std::string &password)
 Creates a connection with the specified user identity. More...
 
virtual cms::ConnectioncreateConnection (const std::string &username, const std::string &password, const std::string &clientId)
 Creates a connection with the specified user identity. More...
 
void setUsername (const std::string &username)
 Sets the username that should be used when creating a new connection. More...
 
const std::string & getUsername () const
 Gets the username that this factory will use when creating a new connection instance. More...
 
void setPassword (const std::string &password)
 Sets the password that should be used when creating a new connection. More...
 
const std::string & getPassword () const
 Gets the password that this factory will use when creating a new connection instance. More...
 
std::string getClientId () const
 Gets the Configured Client Id. More...
 
void setClientId (const std::string &clientId)
 Sets the Client Id. More...
 
void setBrokerURI (const std::string &uri)
 Sets the Broker URI that should be used when creating a new connection instance. More...
 
void setBrokerURI (const decaf::net::URI &uri)
 Sets the Broker URI that should be used when creating a new connection instance. More...
 
const decaf::net::URIgetBrokerURI () const
 Gets the Broker URI that this factory will use when creating a new connection instance. More...
 
virtual void setExceptionListener (cms::ExceptionListener *listener)
 Set an CMS ExceptionListener that will be set on eat connection once it has been created. More...
 
virtual cms::ExceptionListenergetExceptionListener () const
 Returns the currently set ExceptionListener that will be set on any new Connection instance that is created by this factory. More...
 
virtual void setMessageTransformer (cms::MessageTransformer *transformer)
 Set an MessageTransformer instance that is passed on to all Connection objects created from this ConnectionFactory. More...
 
virtual cms::MessageTransformergetMessageTransformer () const
 Gets the currently configured MessageTransformer for this ConnectionFactory. More...
 
void setPrefetchPolicy (PrefetchPolicy *policy)
 Sets the PrefetchPolicy instance that this factory should use when it creates new Connection instances. More...
 
PrefetchPolicygetPrefetchPolicy () const
 Gets the pointer to the current PrefetchPolicy that is in use by this ConnectionFactory. More...
 
void setRedeliveryPolicy (RedeliveryPolicy *policy)
 Sets the RedeliveryPolicy instance that this factory should use when it creates new Connection instances. More...
 
RedeliveryPolicygetRedeliveryPolicy () const
 Gets the pointer to the current RedeliveryPolicy that is in use by this ConnectionFactory. More...
 
bool isDispatchAsync () const
 
void setDispatchAsync (bool value)
 Should messages be dispatched synchronously or asynchronously from the producer thread for non-durable topics in the broker? For fast consumers set this to false. More...
 
bool isAlwaysSyncSend () const
 Gets if the Connection should always send things Synchronously. More...
 
void setAlwaysSyncSend (bool value)
 Sets if the Connection should always send things Synchronously. More...
 
bool isUseAsyncSend () const
 Gets if the useAsyncSend option is set. More...
 
void setUseAsyncSend (bool value)
 Sets the useAsyncSend option. More...
 
bool isSendAcksAsync () const
 Returns whether Message acknowledgments are sent asynchronously meaning no response is required from the broker before the ack completes. More...
 
void setSendAcksAsync (bool sendAcksAsync)
 Sets whether Message acknowledgments are sent asynchronously meaning no response is required from the broker before the ack completes. More...
 
bool isUseCompression () const
 Gets if the Connection is configured for Message body compression. More...
 
void setUseCompression (bool value)
 Sets whether Message body compression is enabled. More...
 
void setCompressionLevel (int value)
 Sets the Compression level used when Message body compression is enabled, a value of -1 causes the Compression Library to use the default setting which is a balance of speed and compression. More...
 
int getCompressionLevel () const
 Gets the currently configured Compression level for Message bodies. More...
 
unsigned int getSendTimeout () const
 Gets the assigned send timeout for this Connector. More...
 
void setSendTimeout (unsigned int timeout)
 Sets the send timeout to use when sending Message objects, this will cause all messages to be sent using a Synchronous request is non-zero. More...
 
unsigned int getCloseTimeout () const
 Gets the assigned close timeout for this Connector. More...
 
void setCloseTimeout (unsigned int timeout)
 Sets the close timeout to use when sending the disconnect request. More...
 
unsigned int getProducerWindowSize () const
 Gets the configured producer window size for Producers that are created from this connector. More...
 
void setProducerWindowSize (unsigned int windowSize)
 Sets the size in Bytes of messages that a producer can send before it is blocked to await a ProducerAck from the broker that frees enough memory to allow another message to be sent. More...
 
bool isMessagePrioritySupported () const
 
void setMessagePrioritySupported (bool value)
 Set whether or not this factory should create Connection objects with the Message priority support function enabled. More...
 
bool isUseRetroactiveConsumer () const
 Should all created consumers be retroactive. More...
 
void setUseRetroactiveConsumer (bool useRetroactiveConsumer)
 Sets whether or not retroactive consumers are enabled. More...
 
bool isExclusiveConsumer () const
 Should all created consumers be exclusive. More...
 
void setExclusiveConsumer (bool exclusiveConsumer)
 Enables or disables whether or not queue consumers should be exclusive or not for example to preserve ordering when not using Message Groups. More...
 
bool isWatchTopicAdvisories () const
 Is the Connection created by this factory configured to watch for advisory messages that inform the Connection about temporary destination create / destroy. More...
 
void setWatchTopicAdvisories (bool value)
 Sets whether Connection's created by this factory will listen for advisory messages regarding temporary destination creation and deletion. More...
 
int getAuditDepth () const
 Get the audit depth for Messages for consumers when using a fault tolerant transport. More...
 
void setAuditDepth (int auditDepth)
 Set the audit depth for Messages for consumers when using a fault tolerant transport. More...
 
int getAuditMaximumProducerNumber () const
 The number of Producers that will be audited. More...
 
void setAuditMaximumProducerNumber (int auditMaximumProducerNumber)
 The number of Producers that will be audited. More...
 
bool isCheckForDuplicates () const
 Gets the value of the configured Duplicate Message detection feature. More...
 
void setCheckForDuplicates (bool checkForDuplicates)
 Gets the value of the configured Duplicate Message detection feature. More...
 
bool isTransactedIndividualAck () const
 when true, submit individual transacted acks immediately rather than with transaction completion. More...
 
void setTransactedIndividualAck (bool transactedIndividualAck)
 when true, submit individual transacted acks immediately rather than with transaction completion. More...
 
bool isNonBlockingRedelivery () const
 Returns true if non-blocking redelivery of Messages is configured for Consumers that are rolled back or recovered. More...
 
void setNonBlockingRedelivery (bool nonBlockingRedelivery)
 When true a MessageConsumer will not stop Message delivery before re-delivering Messages from a rolled back transaction. More...
 
long long getConsumerFailoverRedeliveryWaitPeriod () const
 Gets the delay period for a consumer redelivery. More...
 
void setConsumerFailoverRedeliveryWaitPeriod (long long value)
 Sets the delay period for a consumer redelivery. More...
 
bool isOptimizeAcknowledge () const
 
void setOptimizeAcknowledge (bool optimizeAcknowledge)
 Sets if Consumers are configured to use Optimized Acknowledge by default. More...
 
long long getOptimizeAcknowledgeTimeOut () const
 Gets the time between optimized ack batches in milliseconds. More...
 
void setOptimizeAcknowledgeTimeOut (long long optimizeAcknowledgeTimeOut)
 The max time in milliseconds between optimized ack batches. More...
 
long long getOptimizedAckScheduledAckInterval () const
 Gets the configured time interval that is used to force all MessageConsumers that have optimizedAcknowledge enabled to send an ack for any outstanding Message Acks. More...
 
void setOptimizedAckScheduledAckInterval (long long optimizedAckScheduledAckInterval)
 Sets the amount of time between scheduled sends of any outstanding Message Acks for consumers that have been configured with optimizeAcknowledge enabled. More...
 
bool isAlwaysSessionAsync () const
 Returns the current value of the always session async option. More...
 
void setAlwaysSessionAsync (bool alwaysSessionAsync)
 If this flag is not set 'true' then a separate thread is not used for dispatching messages for each Session in the Connection. More...
 
bool isConsumerExpiryCheckEnabled ()
 
void setConsumerExpiryCheckEnabled (bool consumerExpiryCheckEnabled)
 Configures whether this consumer will perform message expiration processing on all incoming messages. More...
 
- Public Member Functions inherited from cms::ConnectionFactory
virtual ~ConnectionFactory ()
 

Protected Member Functions

virtual ActiveMQConnectioncreateActiveMQConnection (const Pointer< transport::Transport > &transport, const Pointer< decaf::util::Properties > &properties)
 Create a new ActiveMQConnection instnace using the provided Transport and Properties. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from cms::XAConnectionFactory
static XAConnectionFactorycreateCMSXAConnectionFactory (const std::string &brokerURI)
 Static method that is used to create a provider specific XA Connection factory. More...
 
- Static Public Member Functions inherited from activemq::core::ActiveMQConnectionFactory
static cms::ConnectioncreateConnection (const std::string &uri, const std::string &username, const std::string &password, const std::string &clientId="")
 Creates a connection with the specified user identity. More...
 
- Static Public Member Functions inherited from cms::ConnectionFactory
static cms::ConnectionFactorycreateCMSConnectionFactory (const std::string &brokerURI)
 Static method that is used to create a provider specific connection factory. More...
 
- Static Public Attributes inherited from activemq::core::ActiveMQConnectionFactory
static const std::string DEFAULT_URI
 

Constructor & Destructor Documentation

activemq::core::ActiveMQXAConnectionFactory::ActiveMQXAConnectionFactory ( )
activemq::core::ActiveMQXAConnectionFactory::ActiveMQXAConnectionFactory ( const std::string &  uri,
const std::string &  username = "",
const std::string &  password = "" 
)

Constructor.

Parameters
urithe URI of the Broker we are connecting to.
usernameto authenticate with, defaults to ""
passwordto authenticate with, defaults to ""
activemq::core::ActiveMQXAConnectionFactory::ActiveMQXAConnectionFactory ( const decaf::net::URI uri,
const std::string &  username = "",
const std::string &  password = "" 
)

Constructor.

Parameters
urithe URI of the Broker we are connecting to.
usernameto authenticate with, defaults to ""
passwordto authenticate with, defaults to ""
virtual activemq::core::ActiveMQXAConnectionFactory::~ActiveMQXAConnectionFactory ( )
virtual

Member Function Documentation

virtual ActiveMQConnection* activemq::core::ActiveMQXAConnectionFactory::createActiveMQConnection ( const Pointer< transport::Transport > &  transport,
const Pointer< decaf::util::Properties > &  properties 
)
protectedvirtual

Create a new ActiveMQConnection instnace using the provided Transport and Properties.

Subclasses can override this to control the actual type of ActiveMQConnection that is created.

Parameters
transportThe Transport that the Connection should use to communicate with the Broker.
propertiesThe Properties that are assigned to the new Connection instance.
Returns
a new ActiveMQConnection pointer instance.

Reimplemented from activemq::core::ActiveMQConnectionFactory.

virtual cms::XAConnection* activemq::core::ActiveMQXAConnectionFactory::createXAConnection ( )
virtual

Creates an XAConnection with the default user name and password.

The connection is created in stopped mode just as the standard Connection object is created from the ConnectionFactory. No messages will be delivered until the Connection.start method is explicitly called.

Returns
a new XAConnectionFactory instance, the caller owns the returned pointer.
Exceptions
CMSExceptionif an internal error occurs while creating the Connection.
CMSSecurityExceptionif the client authentication fails because the user name or password are invalid.

Implements cms::XAConnectionFactory.

virtual cms::XAConnection* activemq::core::ActiveMQXAConnectionFactory::createXAConnection ( const std::string &  userName,
const std::string &  password 
)
virtual

Creates an XA connection with the specified user name and password.

The connection is created in stopped mode just as the standard ConnectionFactory creates a new Connection. No messages will be delivered until the Connection.start method is explicitly called.

Returns
a new XAConnectionFactory instance, the caller owns the returned pointer.
Exceptions
CMSExceptionif an internal error occurs while creating the Connection.
CMSSecurityExceptionif the client authentication fails because the user name or password are invalid.

Implements cms::XAConnectionFactory.


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