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_Engine_hpp
10 #define anna_diameter_comm_Engine_hpp
18 #include <anna/app/Component.hpp>
19 #include <anna/core/util/Recycler.hpp>
21 #include <anna/diameter.comm/Server.hpp>
22 #include <anna/diameter.comm/ServerSession.hpp>
23 #include <anna/config/defines.hpp>
24 #include <anna/diameter.comm/ClientSession.hpp>
25 #include <anna/diameter.comm/ServerSession.hpp>
31 //------------------------------------------------------------------------------
32 //---------------------------------------------------------------------- #define
33 //------------------------------------------------------------------------------
58 * General manager for connections to several diameter servers and from diameter clients.
60 * Optimizes creation, finding and releasing of established client-sessions to a certain number of
61 * diameter servers through entities.
62 * Optimizes creation, finding and releasing of established server-sessions from a certain number of
63 * diameter clients through local servers.
65 * Implementation example:
69 * class MyEngine : public diameter::comm::Engine {
74 * anna::Recycler<MyEntity> a_entities;
76 * anna::diameter::comm::Entity* allocateEntity () throw () { return a_entities.create (); }
78 * void releaseEntity (anna::diameter::comm::Entity* entity) throw () {
79 * MyEntity* aux = static_cast <MyEntity*> (entity);
80 * a_entities.release (aux);
84 * anna::diameter::comm::LocalServer* allocateLocalServer () throw () { return a_localServers.create (); }
86 * void releaseLocalServer (anna::diameter::comm::LocalServer* localServer) throw () {
87 * MyLocalServer* aux = static_cast <MyLocalServer*> (localServer);
88 * a_localServers.release (aux);
94 class Engine : public anna::app::Component {
98 * Sets the base protocol codec engine used internally
100 * @param baseProtocolCodecEngine This will be used internally during invokation of @readCEA, @readDPA and @readDWA on servers,
101 * and also used during base protocol messages tracing (if debug traces are enabled). You could provide NULL but you must be
102 * sure that neither of the former situations are going to happen or an exception will be thrown. It is recommended to register
103 * a codec engine pointed to a base protocol stack (you can use the files 'avps_ietf.xml' and 'commands_baseProtocol.xml'
104 * located on ANNA suite project under 'source/diameter/stack/setups', or perhaps you can create your own dictionary from
105 * file or directly with the dictionay creation API. Even you can use a greater dictionary (application dictionary), the
106 * only condition is that must contain the resources to build base protocol messages. You could provide this in engine constructor,
107 * but don't forget it.
109 void setBaseProtocolCodecEngine(codec::Engine *baseProtocolCodecEngine) throw() { a_baseProtocolCodecEngine = baseProtocolCodecEngine; }
112 * Gets the base protocol codec engine used internally
114 * @see setBaseProtocolCodecEngine
116 codec::Engine * getBaseProtocolCodecEngine() const throw() { return a_baseProtocolCodecEngine; }
119 Diameter application node realm name (used to be the site domain name).
121 @param name Diameter application node realm name. Used in order to configure the Origin-Realm for outgoing messages.
122 If not configured or empty string provided, host domainname will be set.
124 void setRealm(const std::string & name) throw();
128 Gets the configured diameter application node realm name.
130 @return Diameter application node realm name.
132 const std::string & getRealm() const throw() { return a_realm; }
136 Diameter application host name as solved by #anna::functions::getHostname()
138 @param name Host name. Used in order to configure the Origin-Host for outgoing messages.
139 If not configured or empty string provided, hostname (system name) will be set.
141 void setHost(const std::string & name) throw();
145 Gets the configured diameter application host name.
147 @return Diameter application host name.
149 const std::string & getHost() const throw() { return a_host; }
153 * Propagate auto recovery configuration to entities within engine. Recovery period is configured at
154 * #anna::comm::Communicator::setRecoveryTime. All the client client-sessions created throught #createEntity,
155 * will be created based on the engine auto-recovery value (enable by default). But you could access entities,
156 * servers or client-sessions independently to change this behaviour.
158 * @param autoRecovery Auto recovery indicator. True by default.
160 void raiseAutoRecovery(bool autoRecovery = true) throw(anna::RuntimeException);
163 * Returns automatic bind indicator for client-sessions. By default \em true will be used.
164 * \return Value for automatic connection bind.
166 bool getAutoBind() const throw() { return a_autoBind; }
169 * Sets automatic connection bind indicator for client-sessions. If not asigned, it will be \em true.
170 * \param autoBind Value for automatic connection bind.
172 * In order to change bind timer, first client-session must be created without autobind, modify time
173 * parameter and then invoking bind.
175 void setAutoBind(const bool autoBind) throw() { a_autoBind = autoBind; }
178 Sets the milliseconds wait to achieve a client connection to server by mean connect primitive.
179 This is a general value for born client-sessions over engine. Particular configuration could be done
180 through #ClientSession::setMaxConnectionDelay.
182 \param maxConnectionDelay Milliseconds wait to get connection
184 void setMaxConnectionDelay(const anna::Millisecond & maxConnectionDelay) throw() { a_maxConnectionDelay = maxConnectionDelay; }
187 Gets the milliseconds wait to achieve a client connection to server by mean connect primitive.
188 Returns the global engine value, but it could be overwritten through each client session (#ClientSession::setMaxConnectionDelay).
189 Default value is 'anna::comm::ClientSocket::DefaultMaxConnectionDelay'.
191 \return Milliseconds wait to get connection
193 const anna::Millisecond & getMaxConnectionDelay() throw() { return a_maxConnectionDelay; }
196 * Binds engine entities.
198 * @return Returns true if all client-session were successfully bound
200 bool bind() throw(anna::RuntimeException);
203 * Sets CER and DWR diameter messages to be used over created client-sessions.
204 * Its recommended to set this global configuration although it is possible to configure each client-session separately.
206 * @param cer Capabilities-Exchange-Request message (encoded) for the client-sessions bind.
207 * @param dwr Device-Watchdog-Request message (encoded) for the client-sessions keep-alive.
209 void setClientCERandDWR(const anna::DataBlock & cer, const anna::DataBlock & dwr) throw(anna::RuntimeException);
212 * Sets CER and DWR diameter messages to be used over created client-sessions. If empty string is provided for CER and/or DWR, default version will be configured.
213 * Its recommended to set this global configuration although it is possible to configure each client-session separately.
215 * @param cer Capabilities-Exchange-Request xml message path file for the client-sessions bind. If empty string is provided (default), a default version for CER will be encoded.
216 * @param dwr Device-Watchdog-Request xml message path file for the client-sessions keep-alive. If empty string is provided (default), a default version for DWR will be encoded.
218 void setClientCERandDWR(const std::string & cer = "", const std::string & dwr = "") throw(anna::RuntimeException);
221 * Sets the watchdog period (DWR) for client-sessions.
222 * Its recommended to set this global configuration although it is possible to configure each client-session separately.
224 * @param wp Watchdog period.
226 void setWatchdogPeriod(const anna::Millisecond & wp) throw(anna::RuntimeException);
229 * Gets the number of client-sessions per server.
230 * \return numberOfClientSessionsPerServer Number of client-sessions per server.
232 int getNumberOfClientSessionsPerServer() const throw() { return a_numberOfClientSessionsPerServer; }
235 * Sets the number of client-sessions per server.
236 * Its recommended to set this global configuration although it is possible to configure each client-session separately.
237 * \param numberOfClientSessionsPerServer Number of client-sessions per server.
239 void setNumberOfClientSessionsPerServer(int numberOfClientSessionsPerServer) throw() { a_numberOfClientSessionsPerServer = numberOfClientSessionsPerServer; }
243 * Returns client-session instance identified by (address, port, socketId) provided.
245 * \param addr Diameter server address (ip or hostname).
246 * \param port Diameter server port.
247 * @param socketId Diameter server socket id.
248 * \param emode Action when no client-session is found with provided parameters (Throw/Ignore).
250 * \return The client-session instance identified by (address, port, socketId) provided.
252 * \warning If no client-session found, an exception is launched by default.
254 ClientSession* findClientSession(const std::string & addr, int port, int socketId, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
258 * Same as #findClientSession, but providing client session key (<address>:<port>|<socket id>)
260 ClientSession* findClientSession(const std::string & key, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
264 * Returns server instance identified by pair (address, port) provided.
266 * \param addr Diameter server address (ip or hostname).
267 * \param port Diameter server port.
268 * \param emode Action when no client-session is found with provided parameters (Throw/Ignore).
270 * \return The server instance identified by pair (address, port) provided.
272 * \warning If no server found, an exception is launched by default.
274 Server* findServer(const std::string & addr, int port, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
277 * Returns entity instance identified by internal index.
279 * \param socketList Diameter entity servers list.
280 * \param emode Action when no client-session is found with provided parameters (Throw/Ignore).
282 * \return The entity instance identified by id provided.
284 * \warning If no entity found, an exception is launched by default.
286 Entity* findEntity(const socket_v & socketList, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
289 * Returns entity instance identified by internal index.
291 * \param addr1 Diameter primary server address (ip or hostname).
292 * \param port1 Diameter primary server port.
293 * \param addr2 Diameter secondary server address (ip or hostname).
294 * \param port2 Diameter secondary server port.
295 * \param emode Action when no client-session is found with provided parameters (Throw/Ignore).
297 * \return The entity instance identified by id provided.
299 * \warning If no entity found, an exception is launched by default.
301 Entity* findEntity(const std::string & addr1, int port1, const std::string & addr2, int port2, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
304 * Creates a diameter entity with provided parameters.
306 * Depending on auto-bind configuration, capabilities exchange request will be or won't be performed over the entity client-sessions.
308 * \param socketList Diameter server priority list (priority-ordered) in order to define whole entity.
309 * @param description Optional entity description (empty by default)
311 * \return The entity created or exception when any server (address/port) already exists for another entity.
313 * \warning The entity won't be almost operative until a notification by mean 'ClientSession::eventResponse'
314 * indicates that 'ClassCode::Bind' has been correctly performed for any included client-session.
316 Entity* createEntity(const socket_v & socketList, const std::string & description = "")
317 throw(anna::RuntimeException);
320 * Creates a standard (dual) diameter entity with provided parameters.
322 * Depending on auto-bind configuration, capabilities exchange request will be or won't be performed over the entity client-sessions.
324 * \param addr1 Diameter primary server address (ip or hostname).
325 * \param port1 Diameter primary server port.
326 * \param addr2 Diameter secondary server address (ip or hostname).
327 * \param port2 Diameter secondary server port.
328 * @param description Optional entity description (empty by default)
330 * \return The standard entity created or exception when any server (address/port) already exists for another entity.
332 * \warning The entity won't be almost operative until a notification by mean 'ClientSession::eventResponse'
333 * indicates that 'ClassCode::Bind' has been correctly performed for any included client-session.
335 Entity* createEntity(const std::string & addr1, int port1, const std::string & addr2, int port2, const std::string & description = "")
336 throw(anna::RuntimeException);
340 * Returns local server instance identified by pair (address, port) provided.
342 * @param addr Diameter server socket address (ip or hostname).
343 * @param port Diameter server socket port.
344 * \param emode Action when no local server is found with provided parameters (Throw/Ignore).
346 * \return The local server instance identified by pair (address, port) provided.
348 * \warning If no local server found, an exception is launched by default.
350 LocalServer* findLocalServer(const std::string & addr, int port, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
353 * Returns server-session instance identified by INetAddress serialization provided.
355 * @param socketId Hash for Client Socket INetAddress serialization
356 * \param emode Action when no server-session is found with provided parameters (Throw/Ignore).
358 * \return The server-session instance identified by global unique socketId provided.
360 * \warning If no server-session found, an exception is launched by default.
362 ServerSession* findServerSession(int socketId, anna::Exception::Mode::_v emode = anna::Exception::Mode::Throw) throw(anna::RuntimeException);
365 * Creates a diameter local server with provided parameters.
367 * Server socket address could be an IPv4 or hostname. Default port will be standard 3868 for diameter agents,
368 * but any other could be configured. Socket server could be created with any max accepted connections: zero
369 * value means temporarily disabled and negative values assume no limit (shared bind) for incomming connections.
371 * @param addr Diameter server socket address (ip or hostname).
372 * @param port Diameter server socket port (standard 3868 by default).
373 * @param maxConnections Diameter server max sessions allowed (no limit by default).
374 * @param allowedInactivityTime Max inactivity time for server sessions over the local server before being reset.
375 * @param category Optional socket server category (1 by default).
376 * @param description Optional socket server description (empty by default).
378 * \return The local server created or exception when is already created.
380 LocalServer *createLocalServer(const std::string & addr, int port = Session::DefaultPort, int maxConnections = -1, const anna::Millisecond & allowedInactivityTime = ServerSession::DefaultAllowedInactivityTime, int category = 1, const std::string & description = "")
381 throw(anna::RuntimeException);
385 Close all the engine resources (entities and local servers)
386 Optionally all resources may be freed passing true
388 @param destroy Free all engine entity resources
390 void close(bool destroy = false) throw(anna::RuntimeException) { closeEntities(destroy); closeLocalServers(destroy); }
394 Close all the engine entities (close servers, then close client-sessions within them). Depending on client-session configuration
395 ('OnDisconnect' behaviour), pending answers will be wait (graceful) or ignored (immediate-abrupt close).
396 Optionally all entities resources may be freed passing true; in this case, close is immediately performed:
397 @param destroy Free all engine entity resources
399 void closeEntities(bool destroy = false) throw(anna::RuntimeException);
403 * Close entity servers (then, client-sessions included) and optionally free resources including entity itself.
404 * If entity is null, this operation has no effect.
406 * \param entity Diameter entity to be closed.
407 * \param destroy Deletes entity over the engine and all its resources.
409 void closeEntity(Entity* entity, bool destroy = false) throw(anna::RuntimeException);
413 Close all the engine local server sockets including their children server sessions.
414 Optionally all local server resources may be freed passing true.
416 @param destroy Free all engine local servers resources and server sessions within them.
418 void closeLocalServers(bool destroy = false) throw(anna::RuntimeException);
421 * Close local server socket and its children server sessions.
422 * This is useful when detecting service lost. When service is ready to handle traffic, a new server socket would
423 * be created by mean #LocalServer::enable() and new connections could be accepted.
424 * Optionally local server resources may be freed passing true.
426 * \param localServer Local server to be closed.
427 * \param destroy Deletes local server over engine and all its resources (server sessions within it).
429 void closeLocalServer(LocalServer * localServer, bool destroy = false) throw(anna::RuntimeException);
432 Gets the number of requests messages over-the-air for entities.
434 @return OTA messages.
436 int getOTARequestsForEntities() const throw();
439 Gets the number of requests messages over-the-air for local servers.
441 @return OTA messages.
443 int getOTARequestsForLocalServers() const throw();
446 Gets the number of requests messages over-the-air for entities plus local servers.
448 @return OTA messages.
450 int getOTARequests() const throw() { return (getOTARequestsForEntities() + getOTARequestsForLocalServers()); }
453 Returns idle state (no pending answers) for entities.
457 bool idleForEntities() const throw() { return (getOTARequestsForEntities() == 0); }
460 Returns idle state (no pending answers).
464 bool idleForLocalServers() const throw() { return (getOTARequestsForLocalServers() == 0); }
467 Returns idle state (no pending answers for entities or local servers).
471 bool idle() const throw() { return (getOTARequests() == 0); }
474 Sent a message to all the engine entities.
475 It is used, i.e., in Disconnect-Peer-Request procedure over the engine.
477 \param message Message which is being sent.
479 @return Returns true (success) only when broadcast is success over all the engine entities. If any entity fails,
480 then false is returned. Broadcast try to send all over the resources in spite of any fail.
482 bool broadcastEntities(const Message*message) throw(anna::RuntimeException);
483 bool broadcastEntities(const Message& message) throw(anna::RuntimeException) { return broadcastEntities(&message); }
486 Sent a message through all the engine local servers.
487 It is used, i.e., in Disconnect-Peer-Request procedure over the engine.
489 \param message Message which is being sent.
491 @return Returns true (success) only when broadcast is success over all the engine local servers. If any local server fails,
492 then false is returned. Broadcast try to send all over the resources in spite of any fail.
494 bool broadcastLocalServers(const Message*message) throw(anna::RuntimeException);
495 bool broadcastLocalServers(const Message& message) throw(anna::RuntimeException) { return broadcastLocalServers(&message); }
498 * Class string representation
500 * @return String with class content
502 virtual std::string asString(void) const throw();
505 Class XML representation.
506 \param parent XML node over which we will put instance information.
507 \return XML documentcon with class content.
509 virtual anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
513 When there is not bound server session over the engine, this virtual method will be invoked.
514 Applications must decide to do any other tasks at this idle/isolated situation.
515 Default implementation do nothing.
517 virtual void availabilityLostForLocalServers(Engine *) const throw() {;}
520 When there is any bound server session over the engine, this virtual method will be invoked.
521 Applications must decide to do be ready for incoming traffic.
522 Default implementation do nothing.
524 virtual void availabilityRecoveredForLocalServers(Engine *) const throw() {;}
527 When there is not bound entity over the engine, this virtual method will be invoked.
528 Many applications must change communicator status to Unavailable when no engines are available.
529 Default implementation do nothing.
531 virtual void availabilityLostForEntities(Engine *) const throw() {;}
534 When there is any bound entity over the engine, this virtual method will be invoked.
535 Many applications must recover communicator status to Available when any engine are available.
536 Default implementation do nothing.
538 virtual void availabilityRecoveredForEntities(Engine *) const throw() {;}
541 When there is not bound server-session over the local server, this virtual method will be invoked.
542 Default implementation do nothing.
544 virtual void availabilityLost(LocalServer *) const throw() {;}
547 When there is any bound server-session over the local server, this virtual method will be invoked.
548 Default implementation do nothing.
550 virtual void availabilityRecovered(LocalServer *) const throw() {;}
553 When there is not bound server over the entity, this virtual method will be invoked.
554 Default implementation do nothing.
556 virtual void availabilityLost(Entity *) const throw() {;}
559 When there is any bound server over the entity, this virtual method will be invoked.
560 Default implementation do nothing.
562 virtual void availabilityRecovered(Entity *) const throw() {;}
565 When there is not bound client-session over the server, this virtual method will be invoked.
566 Default implementation do nothing.
568 virtual void availabilityLost(Server *) const throw() {;}
571 When there is any bound client-session over the server, this virtual method will be invoked.
572 Default implementation do nothing.
574 virtual void availabilityRecovered(Server *) const throw() {;}
577 When a subyacent client session is going to be bound, this method is invoked before.
578 Default implementation do nothing.
580 virtual void bindingClientSession(const ClientSession *) const throw() {;}
583 * Class user should implement this method in order to define Disconnect-Peer-Answer for last received DPR.
584 * Origin-Host and Origin-Realm are configured at comm::Engine with hostname and FQDN (Fully Qualified Domain Name).
585 * Default implementation imply DPA with DIAMETER_SUCCESS Result-Code, allowing remote disconnection.
586 * Any other implementation is responsible to build a valid DPA diameter message.
587 * DPR/DPA procedure is disabled with empty definition of this method: no DPA will be sent when DPR is received.
589 * @param dpa DPA datablock passed as reference
590 * @param dpr Corresponding DPR received (sequence values must be taken into account in order to build DPA)
592 virtual void readDPA(anna::DataBlock &dpa, const anna::DataBlock & dpr) throw();
595 * Class user should implement this method in order to define Capabilities-Exchange-Answer for received CER over server socket.
596 * Origin-Host and Origin-Realm are configured at comm::Engine with hostname and FQDN (Fully Qualified Domain Name).
597 * Default implementation imply CEA with DIAMETER_SUCCESS Result-Code, and own domain node parameters, but application should
598 * analyze the CER message in order to accept it or not (with apropiate non-success Result-Code).
599 * Any other implementation is responsible to build a valid CEA diameter message:
601 * If one peer sends a CER message to another Peer and receiver does not have support for
603 * 1) any common application then it must return the CEA with Result-Code Avp set to DIAMETER_NO_COMMON_APPLICATION
604 * and should disconnect the transport layer connection (automatically done by diameter::comm module).
605 * 2) no common security mechanism then it must return the CEA with Result-Code Avp set to DIAMETER_NO_COMMON_SECURITY
606 * and should disconnect the transport layer connection (automatically done by diameter::comm module).
607 * 3) if CER is received from any unknown peer then receiver should discard the message, or send the CEA with the
608 * Result-Code Avp set to DIAMETER_UNKNOWN_PEER.
610 * If the local implementation policy permits to receive CER from unknown hosts, a successful CEA MAY be returned,
611 * and the life time of the peer entry in PEER-Table is equal to the lifetime of the transport connection.
612 * If in any case transport connection fails then all the pending transactions destined to the unknown peer can be discarded.
614 * The CER and CEA messages MUST NOT be proxied, redirected or relayed. Since CER/CEA messages can not be proxied, but still
615 * it is possible that proxy will receive a CER message and proxy does not have any peer to handle the application requested
616 * in CER, in this case proxy set the E bit in CEA and set the Result-Code Avp to DIAMETER_UNABLE_TO_DELIVER, sends back to
617 * CER generator peer.
619 * @param cea CEA datablock passed as reference. Empty cea implies to discard CER received.
620 * @param cer Corresponding CER received (sequence values must be taken into account in order to build CEA)
622 virtual void readCEA(anna::DataBlock &cea, const anna::DataBlock & cer) throw();
625 * Class user should implement this method in order to define Device-Watchdog-Answer for received DWR over server socket.
626 * Origin-Host and Origin-Realm are configured at comm::Engine with hostname and FQDN (Fully Qualified Domain Name).
627 * Default implementation imply DWA with DIAMETER_SUCCESS Result-Code, and own domain node parameters.
628 * Any other implementation is responsible to build a valid DWA diameter message.
630 * @param dwa DWA datablock passed as reference
631 * @param dwr Corresponding DWR received (sequence values must be taken into account in order to build DWA)
633 virtual void readDWA(anna::DataBlock &dwa, const anna::DataBlock & dwr) throw();
636 Reset engine statistics.
637 At the moment, only diameter servers processing time is observed.
639 void resetStatistics() throw();
643 * Engine lazy initialization. Used if the engine is created when application is already running; for example
644 * on dynamic realms registration. At the moment is not actually needed (nothing is done at initialization),
645 * but it is recommended to start the component and set its state as 'running' from the point of view of the
648 void lazyInitialize() throw(RuntimeException);
655 @param className Component class name
656 @param baseProtocolCodecEngine This will be used internally during invokation of @readCEA, @readDPA and @readDWA on servers,
657 and also used during base protocol messages tracing (if debug traces are enabled). You could provide NULL but you must be
658 sure that neither of the former situations are going to happen or an exception will be thrown. It is recommended to register
659 a codec engine pointed to a base protocol stack (you can use the files 'avps_ietf.xml' and 'commands_baseProtocol.xml'
660 located on ANNA suite project under 'source/diameter/stack/setups', or perhaps you can create your own dictionary from
661 file or directly with the dictionay creation API. Even you can use a greater dictionary (application dictionary), the
662 only condition is that must contain the resources to build base protocol messages. You could use @setBaseProtocolCodecEngine
663 to set this reference later; don't forget it.
665 Engine(const char *className, codec::Engine *baseProtocolCodecEngine);
668 // INTERNAL CREATORS AND CLOSE METHODS
669 Server *createServer(Entity*, const socket_t&) throw(anna::RuntimeException);
670 void closeServer(Server*, bool) throw(anna::RuntimeException);
671 ClientSession *createClientSession(Server*, int) throw(anna::RuntimeException);
672 void closeClientSession(ClientSession*, bool) throw(anna::RuntimeException);
674 // INTERNAL ALLOCATORS
675 Server* allocateServer() throw();
676 void releaseServer(Server*) throw();
677 ClientSession* allocateClientSession() throw();
678 void releaseClientSession(ClientSession*) throw();
682 Entity allocator method.
684 It is recommended to use anna::Recycler for entities creation/releasing.
688 virtual Entity* allocateEntity() throw() { return NULL; }
692 Invoked to free entities.
695 virtual void releaseEntity(Entity*) throw() {;}
699 Local server allocator method.
701 It is recommended to use anna::Recycler for entities creation/releasing.
705 virtual LocalServer* allocateLocalServer() throw() { return NULL; }
709 Invoked to free local servers.
712 virtual void releaseLocalServer(LocalServer*) throw() {;}
718 // Internal use: tracing and readCEA/DPA/DWA
719 codec::Engine *a_baseProtocolCodecEngine;
724 int a_numberOfClientSessionsPerServer;
727 // ClientSessions messages:
728 anna::DataBlock a_cer;
729 anna::DataBlock a_dwr;
730 anna::Millisecond a_watchdogPeriod;
732 // // ServerSessions messages:
733 // anna::DataBlock a_cea;
734 // anna::DataBlock a_dwa;
736 // Client connectivity
737 anna::Millisecond a_maxConnectionDelay;
741 bool a_availableForEntities; // any of the entities must be bound
742 void availabilityLostForEntities() throw();
743 void availabilityRecoveredForEntities() throw();
744 bool refreshAvailabilityForEntities() throw(); // return true if change
746 bool a_availableForLocalServers; // any of the local servers must be bound
747 void availabilityLostForLocalServers() throw();
748 void availabilityRecoveredForLocalServers() throw();
749 bool refreshAvailabilityForLocalServers() throw(); // return true if change
751 void eraseDeprecatedIdleEntities() throw();
754 void do_initialize() throw(anna::RuntimeException);
755 void do_stop() throw();
758 void checkEntityCollision(const socket_v &) throw(anna::RuntimeException);
761 //////////////////////////
762 // CLIENT FUNCTIONALITY //
763 //////////////////////////
765 //typedef int clientSession_key; // exclusiveHash('ADDR:PORT|id')
766 typedef std::string clientSession_key; // 'ADDR:PORT|id'
767 typedef std::map <clientSession_key, ClientSession*> clientSession_container;
768 typedef clientSession_container::value_type clientSession_value_type;
769 typedef clientSession_container::iterator clientSession_iterator;
770 typedef clientSession_container::const_iterator const_clientSession_iterator;
771 clientSession_container a_clientSessions;
772 anna::Recycler<ClientSession> a_clientSessionsRecycler;
773 clientSession_iterator clientSession_find(const clientSession_key&) throw();
774 clientSession_iterator clientSession_begin() throw() { return a_clientSessions.begin(); }
775 clientSession_iterator clientSession_end() throw() { return a_clientSessions.end(); }
776 static ClientSession* clientSession(clientSession_iterator ii) throw() { return ii->second; }
777 const_clientSession_iterator clientSession_begin() const throw() { return a_clientSessions.begin(); }
778 const_clientSession_iterator clientSession_end() const throw() { return a_clientSessions.end(); }
779 static const ClientSession* clientSession(const_clientSession_iterator ii) throw() { return ii->second; }
781 typedef socket_t server_key;
782 server_key getServerKey(const std::string & addr, int port) const throw();
783 typedef std::map <server_key, Server*> server_container;
784 typedef server_container::value_type server_value_type;
785 typedef server_container::iterator server_iterator;
786 typedef server_container::const_iterator const_server_iterator;
787 server_container a_servers;
788 anna::Recycler<Server> a_serversRecycler;
789 server_iterator server_find(const server_key&) throw();
790 server_iterator server_begin() throw() { return a_servers.begin(); }
791 server_iterator server_end() throw() { return a_servers.end(); }
792 static Server* server(server_iterator ii) throw() { return ii->second; }
793 const_server_iterator server_begin() const throw() { return a_servers.begin(); }
794 const_server_iterator server_end() const throw() { return a_servers.end(); }
795 static const Server* server(const_server_iterator ii) throw() { return ii->second; }
797 //typedef int entity_key; // exclusiveHash('IP1:PORT1 IP2:PORT2 IP3:PORT3 ...')
798 typedef std::string entity_key; // 'ADDR1:PORT1 ADDR2:PORT2 ADDR3:PORT3 ...'
799 entity_key getEntityKey(const socket_v &) const throw();
800 entity_key getEntityKey(const std::string & addr1, int port1, const std::string & addr2, int port2) const throw();
801 typedef std::map <entity_key, Entity*> entity_container;
802 typedef entity_container::value_type entity_value_type;
803 typedef entity_container::iterator entity_iterator;
804 typedef entity_container::const_iterator const_entity_iterator;
805 entity_container a_entities;
806 entity_iterator entity_find(const entity_key&) throw();
807 entity_iterator entity_begin() throw() { return a_entities.begin(); }
808 entity_iterator entity_end() throw() { return a_entities.end(); }
809 static Entity* entity(entity_iterator ii) throw() { return ii->second; }
810 const_entity_iterator entity_begin() const throw() { return a_entities.begin(); }
811 const_entity_iterator entity_end() const throw() { return a_entities.end(); }
812 static const Entity* entity(const_entity_iterator ii) throw() { return ii->second; }
815 //////////////////////////
816 // SERVER FUNCTIONALITY //
817 //////////////////////////
820 typedef std::map <socket_t, LocalServer*> localServer_container;
821 typedef localServer_container::value_type localServer_value_type;
822 typedef localServer_container::iterator localServer_iterator;
823 typedef localServer_container::const_iterator const_localServer_iterator;
824 localServer_container a_localServers;
825 localServer_iterator localServer_find(const socket_t&) throw();
826 localServer_iterator localServer_begin() throw() { return a_localServers.begin(); }
827 localServer_iterator localServer_end() throw() { return a_localServers.end(); }
828 static LocalServer* localServer(localServer_iterator ii) throw() { return ii->second; }
829 const_localServer_iterator localServer_begin() const throw() { return a_localServers.begin(); }
830 const_localServer_iterator localServer_end() const throw() { return a_localServers.end(); }
831 static const LocalServer* localServer(const_localServer_iterator ii) throw() { return ii->second; }
833 // Server sessions are managed within LocalServer (not at engine) due to dynamic cration nature
836 friend class Session;
837 friend class ServerSession;
838 friend class ServerSocket;
841 friend class LocalServer;
842 //friend class Message;