Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

pana_node.h

00001 /* BEGIN_COPYRIGHT                                                        */
00002 /*                                                                        */
00003 /* Open Diameter: Open-source software for the Diameter and               */
00004 /*                Diameter related protocols                              */
00005 /*                                                                        */
00006 /* Copyright (C) 2002-2004 Open Diameter Project                          */
00007 /*                                                                        */
00008 /* This library is free software; you can redistribute it and/or modify   */
00009 /* it under the terms of the GNU Lesser General Public License as         */
00010 /* published by the Free Software Foundation; either version 2.1 of the   */
00011 /* License, or (at your option) any later version.                        */
00012 /*                                                                        */
00013 /* This library is distributed in the hope that it will be useful,        */
00014 /* but WITHOUT ANY WARRANTY; without even the implied warranty of         */
00015 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU      */
00016 /* Lesser General Public License for more details.                        */
00017 /*                                                                        */
00018 /* You should have received a copy of the GNU Lesser General Public       */
00019 /* License along with this library; if not, write to the Free Software    */
00020 /* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307    */
00021 /* USA.                                                                   */
00022 /*                                                                        */
00023 /* In addition, when you copy and redistribute some or the entire part of */
00024 /* the source code of this software with or without modification, you     */
00025 /* MUST include this copyright notice in each copy.                       */
00026 /*                                                                        */
00027 /* If you make any changes that are appeared to be useful, please send    */
00028 /* sources that include the changed part to                               */
00029 /* diameter-developers@lists.sourceforge.net so that we can reflect your  */
00030 /* changes to one unified version of this software.                       */
00031 /*                                                                        */
00032 /* END_COPYRIGHT                                                          */
00033 
00034 #ifndef __PANA_NODE_H__
00035 #define __PANA_NODE_H__
00036 
00037 #include "pana_exports.h"
00038 #include "framework.h"
00039 
00040 /* \brief PANA Node interface
00041  *
00042  * An instance of this class represents an instance of
00043  * a PANA protocol entity. Note that the role for this
00044  * entity is required at creation.
00045  *
00046  * The PANA core is an active object entity with an 
00047  * underlying thread pool. Provisions on starting,
00048  * pausing, resuming and stopping protocol functions
00049  * are based on internal thread pool execution states.
00050  *
00051  */
00052 class PANA_EXPORT PANA_Node
00053 {
00054    public:
00055        PANA_Node(AAA_Task &t, std::string &cfg_file) : 
00056            m_Task(t) {
00057            Start(cfg_file);
00058        }
00059        virtual ~PANA_Node() {
00060            Stop();
00061        }
00062        AAA_Task &Task() {
00063            return m_Task;
00064        }
00065        AAA_GroupedJob &Job() {
00066            return m_Task.Job();
00067        }
00068 
00069    protected:
00070        void Start(std::string &cfg_file);
00071        void Stop();
00072 
00073    private:
00074        AAA_Task &m_Task;
00075 };
00076 
00077 #endif /* __PANA_NODE_H__ */

Generated on Fri Jun 25 19:18:29 2004 for PANA by doxygen 1.3.5