1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
9 #ifndef anna_diameter_comm_ClientSession_hpp
10 #define anna_diameter_comm_ClientSession_hpp
16 #include <anna/core/util/SortedVector.hpp>
17 #include <anna/core/util/Millisecond.hpp>
18 #include <anna/core/RuntimeException.hpp>
20 #include <anna/diameter.comm/Session.hpp>
21 #include <anna/diameter/defines.hpp>
22 #include <anna/diameter.comm/Message.hpp>
23 #include <anna/diameter.comm/ClientSessionReceiver.hpp>
24 #include <anna/diameter.comm/ReceiverFactoryImpl.hpp>
49 Modela la conexion realizada contra un servidor diameter.
51 class ClientSession : public Session {
54 static std::string getKey(const std::string & addr, int port, int socketId) throw() {
55 return (anna::functions::asString("%s:%d|%d", addr.c_str(), port, socketId));
58 bool a_hidden; // hide resource for restricted delivery over servers/entities
66 /* virtual */void initialize() throw();
69 * Default watchdog period for the diameter client-session health.
71 static const anna::Millisecond DefaultWatchdogPeriod;
74 Client session key: <address ip or hostname>:<remote port>|<socket id: 0..N-1>
76 std::string getKey() const throw() { return ClientSession::getKey(getAddress(), getPort(), getSocketId()); }
79 Diameter server address (IPv4 or hostname)
80 \return Diameter server address
82 /* virtual */const std::string& getAddress() const throw();
85 Diameter server listen port
86 \return Diameter server listen port
88 /* virtual */int getPort() const throw();
91 Diameter parent server.
92 \return Diameter parent server.
94 const Server *getParent() const throw() { return a_parent; }
97 Diameter server created at diameter::comm::Engine::createClientSession.
98 \return Diameter server
100 anna::comm::Server * getServer() throw() { return a_server; }
103 Disables server resource (avoid the use of the server)
105 void disable() throw() { a_server->disable(); }
108 Sets auto recovery indicator. When a connection is lost, by default it will be recovered automatically.
109 \param autoRecovery Auto recovery indicator. TRue by default.
111 void setAutoRecovery(bool autoRecovery = true) throw() { a_autoRecovery = autoRecovery; a_server->setAutoRecovery(autoRecovery); }
114 Gets the auto recovery indicator for the client connection (client-session).
116 @return Auto recovery indicator.
118 bool getAutoRecovery() const throw() { return a_autoRecovery; }
121 Sets the milliseconds wait to achieve a client connection to server by mean connect primitive.
122 This allow to perform specific configurations (some servers could be slower than others).
123 Changes will be taken into account on the next connect operation.
125 \param maxConnectionDelay Milliseconds wait to get connection
127 void setMaxConnectionDelay(const anna::Millisecond & maxConnectionDelay) throw() { a_server->setMaxConnectionDelay(maxConnectionDelay); }
130 Gets the milliseconds wait to achieve a client connection to server by mean connect primitive.
132 \return Milliseconds wait to get connection
134 const anna::Millisecond & getMaxConnectionDelay() throw() { return a_server->getMaxConnectionDelay(); }
137 * Sets CER and DWR diameter messages to be used over created client-sessions
139 * @param cer Capabilities-Exchange-Request message (encoded) for the client-sessions bind.
140 * @param dwr Device-Watchdog-Request message (encoded) for the client-sessions keep-alive.
142 void setCERandDWR(const anna::DataBlock & cer, const anna::DataBlock & dwr) throw(anna::RuntimeException);
145 void bind() throw(anna::RuntimeException);
147 /* virtual */const Response* send(const Message* message) throw(anna::RuntimeException);
148 /* virtual */bool unbind(bool forceDisconnect /* se usa en timer, para el actionTimer del tipo SessionUnbind, etc. */ = false) throw(anna::RuntimeException); // returns true if done at call time (no pendings or ignore pendings, except Disconnecting state by mean DPR/DPA)
151 Deny resource for delivery restriction
153 void hide() throw() { a_hidden = true; }
156 Allow resource for delivery permission
158 void show() throw() { a_hidden = false; }
161 Returns true when client session resource is hidden for application messages delivery
163 bool hidden() const throw() { return a_hidden; }
166 Returns true when client session resource is shown for application messages delivery
168 bool shown() const throw() { return !a_hidden; }
172 Class string representation
173 \return String with relevant information for this instance.
175 /* virtual */std::string asString() const throw();
179 Class xml representation
180 \param parent Parent XML node on which hold this instance information.
181 \return XML document with relevant information for this instance.
183 /* virtual */anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
189 ReceiverFactoryImpl<ClientSession, ClientSessionReceiver> a_receiverFactory;
191 // Parent information
194 // ClientSession messages:
202 anna::comm::Server *a_server;
205 struct WatchdogState {
207 TimerStopped, // Until CEA (bound state), timer is stopped
208 WaitingTimerExpiration, // DWA has been received and we wait for next expiration to send DWR
209 WaitingDWA // DWR has been sent, but DWA hasn't been received yet
212 WatchdogState::_v a_watchdogState;
213 void setWatchdogState(WatchdogState::_v wState) throw();
215 /* virtual */void expire(anna::timex::Engine *timeController) throw(anna::RuntimeException);
216 void setWatchdogPeriod(const anna::Millisecond & watchdogPeriod) throw();
218 /*virtual*/ void timerStopped() throw();
219 /*virtual*/ void timerStarted() throw();
223 /* virtual */void updateIncomingActivityTime() throw();
224 /* virtual */void updateOutgoingActivityTime() throw();
225 void countSendings(const diameter::CommandId & cid, unsigned int aid, bool ok) throw();
229 Handler about event break connection from diameter server over this client-session.
231 When notified, ANNA.diameter.comm generates an diameter::comm::ClientSession::eventResponse for every request with pending answers.
233 void eventPeerShutdown() throw();
236 Handler for diameter server (client-session) responses
238 \param response Answer container object for corresponding diameter request
240 void eventResponse(const Response& response) throw(anna::RuntimeException);
243 Handler for diameter server (client-session) requests
245 \param request Request data block object for corresponding diameter reception
247 void eventRequest(const anna::DataBlock& request) throw(anna::RuntimeException);
248 //void eventRequest(const Message& request) throw(anna::RuntimeException);
251 Handler for diameter server (client-session) responses out of context
253 \param response Answer data block object without context match
255 void eventUnknownResponse(const anna::DataBlock& response) throw(anna::RuntimeException);
258 Handler for diameter server (client-session) Disconnect-Peer-Answer messages
260 \param response Answer data block object without context match
262 void eventDPA(const anna::DataBlock& response) throw(anna::RuntimeException);
267 * Handlers for receptions
269 /* virtual */void receive(const anna::comm::Message& message) throw(anna::RuntimeException);
270 /* virtual */void finalize() throw();
271 void recover() throw();
273 /* virtual */void expireResponse(Response*) throw();
274 /* virtual */void setState(State::_v state) throw();
276 void sendDWAToServer(const anna::DataBlock& dwrDB) throw(anna::RuntimeException); // non-usual behaviour, but DWR could be received from server
279 static const char* asText(const WatchdogState::_v) throw();
284 friend class ClientSessionReceiver;