session.H

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2002 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

#ifndef ARCHON_X3D_SAI_SESSION_H
#define ARCHON_X3D_SAI_SESSION_H

#include <vector>
#include <queue>

#include <archon/util/logger.H>
#include <archon/util/ref.H>
#include <archon/util/mutex.H>

#include <archon/x3d/server/load.H>

#include <archon/x3d/sai/orb.H>
#include <archon/x3d/sai/sai.H>
#include <archon/x3d/sai/value.H>
#include <archon/x3d/sai/change.H>
#include <archon/x3d/sai/app_scene.H>

namespace Archon
{
  namespace X3D
  {
    namespace SAI
    {
      using namespace Utilities;
  
      struct Listener;
      struct ExternalRouteHead;

      struct Session: Porter, AbstractFileServer, Logger
      {
        Session(Ref<Listener> listener,
                x3d::sai::Application_ptr);
      
        ~Session();

        x3d::sai::Session_ptr createServant(Time heartbeat);

        unsigned long node2id(Ref<NodeBase>);
        Ref<NodeBase> id2node(unsigned long) throw(IllegalNodeIdException);

        // Session (or Browser) services
        char *getServerName();
        CORBA::Double getCurrentFrameRate();
        CORBA::ULong createApplicationScene(const char *, CORBA::Boolean);
        CORBA::ULong loadApplicationScene(const char *, CORBA::Boolean);
        void launchApplicationScene(CORBA::ULong);
        void withdrawApplicationScene(CORBA::ULong);
        void beginUpdate();
        void endUpdate();
        void print(const char *);
        void setSynchronizedChangesEnabled(CORBA::Boolean);
        void disposeBatch(const x3d::sai::DisposeSeq &,
                          const x3d::sai::DisposeSeq &);
        void disposeSession();

        // ExecutionContext services
        char *getBaseUri(CORBA::ULong);
        CORBA::ULong getRootGroup(CORBA::ULong);
        void setRootGroup(CORBA::ULong, CORBA::ULong);
        CORBA::ULong createNode(CORBA::ULong, const char *);
        CORBA::ULong createNode(CORBA::ULong, CORBA::ULong);
        CORBA::ULong getNode(CORBA::ULong, const char *);
        void addRoute(CORBA::ULong, CORBA::ULong, CORBA::ULong,
                      CORBA::ULong, CORBA::ULong);
        void delRoute(CORBA::ULong, CORBA::ULong, CORBA::ULong,
                      CORBA::ULong, CORBA::ULong);
        CORBA::ULong createGroupFromStream(CORBA::ULong,
                                           x3d::sai::StreamReader_ptr);
        void disposeContext(CORBA::ULong);

        // Node services
        char *getNodeType(CORBA::ULong);
        CORBA::ULong getField(CORBA::ULong, const char *);
        void disposeNode(CORBA::ULong);

        // Field services
        CORBA::ULong getFieldType(CORBA::ULong, CORBA::ULong);
        char *getFieldName(CORBA::ULong, CORBA::ULong);
        CORBA::ULong getFieldAccessType(CORBA::ULong, CORBA::ULong);
        void registerFieldInterest(CORBA::ULong, CORBA::ULong,
                                   CORBA::ULong);
        void unRegisterFieldInterest(CORBA::ULong, CORBA::ULong,
                                     CORBA::ULong);
        x3d::sai::Value *getFieldValue(CORBA::ULong, CORBA::ULong);
        void setFieldValue(CORBA::ULong, CORBA::ULong,
                           const x3d::sai::Value &);
        x3d::sai::Value *getFieldValueAt(CORBA::ULong, CORBA::ULong,
                                         CORBA::ULong);
        void setFieldValueAt(CORBA::ULong, CORBA::ULong, CORBA::ULong,
                             const x3d::sai::Value &);
        void setFieldValueAdd(CORBA::ULong, CORBA::ULong,
                              const x3d::sai::Value &);
        void setFieldValueDel(CORBA::ULong, CORBA::ULong,
                              const x3d::sai::Value &);
        void disposeField(CORBA::ULong) {}

        void executeChanges();

        void handleChange(Ref<const ChangeBase>);

        void handleExternalEvent(const ValueBase *v, unsigned long cookie);

        void addRouteHead(Ref<const ExternalRouteHead>);
        void removeRouteHead(Ref<const ExternalRouteHead>);
      
        const BackRef<Listener> listener;

      private:
        void refForwardDestroy();

        Orb &orb;

        const x3d::sai::Application_var application;


        struct ExternalEvent;
        struct ExternalEventQueue;

        Ref<ExternalEventQueue> externalEventQueue;

        void pushEvents(const list<ExternalEvent> *);
      

        Mutex mutex;

        struct Servant;
        PortableServer::ObjectId_var servantId;
        bool active;

        x3d::sai::Session_ptr activate(Time heartbeat);

        void deactivate();

        RefMap<ExecutionContext> contextMap;

        RefMap<NodeBase> nodeMap;

        queue<Ref<const ChangeBase> > changeQueue;

        list<Ref<ApplicationScene> > launchedScenes;

        bool buffered;
        bool synchronizedChanges;

        // Overriding from X3D::AbstractFileServer
        Ref<Stream::Reader> request(string)
          throw(AbstractFileServer::RequestException);

        // Overriding from Utilities::Logger
        void log(string) throw();

        Mutex routeHeadsMutex;
        list<Ref<const ExternalRouteHead> > routeHeads;
      };
    }
  }
}

#endif // ARCHON_X3D_SAI_SESSION_H

---