activemq-cpp-3.9.5
Connection.h
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef _CMS_CONNECTION_H_
19#define _CMS_CONNECTION_H_
20
21#include <cms/Config.h>
22#include <cms/Startable.h>
23#include <cms/Stoppable.h>
24#include <cms/Closeable.h>
25#include <cms/Session.h>
27
28namespace cms {
29
32
70 class CMS_API Connection : public Startable, public Stoppable, public Closeable {
71 public:
72
73 virtual ~Connection();
74
81 virtual void close() = 0;
82
94 virtual const ConnectionMetaData* getMetaData() const = 0;
95
101 virtual Session* createSession() = 0;
102
113
122 virtual std::string getClientID() const = 0;
123
142 virtual void setClientID(const std::string& clientID) = 0;
143
150
157 virtual void setExceptionListener(ExceptionListener* listener) = 0;
158
170 virtual void setMessageTransformer(cms::MessageTransformer* transformer) = 0;
171
178
179 };
180
181}
182
183#endif /*_CMS_CONNECTION_H_*/
Interface for a class that implements the close method.
Definition Closeable.h:35
The client's connection to its provider.
Definition Connection.h:70
virtual void close()=0
Closes this connection as well as any Sessions created from it (and those Sessions' consumers and pro...
virtual cms::MessageTransformer * getMessageTransformer() const =0
Gets the currently configured MessageTransformer for this Connection.
virtual Session * createSession(Session::AcknowledgeMode ackMode)=0
Creates a new Session to work for this Connection using the specified acknowledgment mode.
virtual void setClientID(const std::string &clientID)=0
Sets the client identifier for this connection.
virtual const ConnectionMetaData * getMetaData() const =0
Gets the metadata for this connection.
virtual void setMessageTransformer(cms::MessageTransformer *transformer)=0
Set an MessageTransformer instance that is passed on to all Session objects created from this Connect...
virtual std::string getClientID() const =0
Get the Client Id for this session, the client Id is provider specific and is either assigned by the ...
virtual Session * createSession()=0
Creates an AUTO_ACKNOWLEDGE Session.
virtual ~Connection()
virtual ExceptionListener * getExceptionListener() const =0
Gets the registered Exception Listener for this connection.
virtual void setExceptionListener(ExceptionListener *listener)=0
Sets the registered Exception Listener for this connection.
A ConnectionMetaData object provides information describing the Connection object.
Definition ConnectionMetaData.h:31
If a CMS provider detects a serious problem, it notifies the client application through an ExceptionL...
Definition ExceptionListener.h:37
Provides an interface for clients to transform cms::Message objects inside the CMS MessageProducer an...
Definition MessageTransformer.h:37
A Session object is a single-threaded context for producing and consuming messages.
Definition Session.h:105
AcknowledgeMode
Definition Session.h:108
Interface for a class that implements the start method.
Definition Startable.h:36
Interface for a class that implements the stop method.
Definition Stoppable.h:36
#define CMS_API
Definition Config.h:31
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
Definition DestinationResolver.h:23