network.H

Go to the documentation of this file.

/*
 * 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_NETWORK_H
#define ARCHON_X3D_NETWORK_H

#include <vector>

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

namespace Archon
{
  namespace X3D
  {
    struct UrlObject: virtual NodeBase
    {
      static const NodeType *type;

      Ref<const Loader::Contents> getContents() const;

    protected:
      UrlObject();
      virtual ~UrlObject();

      void addUri(string, Time stamp);

      virtual void clear() {}

      virtual void onLoaded() {}

      virtual bool mayStartLoading() const { return true; }

      void startLoading();

    private:
      friend void initializeNetworkComponent();

      vector<string> url;

      EventSource urlChanged;

      Time urlStamp;


      struct LoaderJob: Loader::Job
      {
        LoaderJob(UrlObject *urlObject, Ref<Loader> loader, Uri baseUri,
                  const vector<string> &uriList, Loader::UriType uriType,
                  Ref<AbstractFileServer> fileServer):
          Loader::Job(loader, baseUri, uriList, uriType, fileServer),
          urlObject(urlObject) {}

        void kill();

      private:
        void onCompletion();

        Mutex mutex;
        UrlObject *urlObject;
      };


      Mutex loaderMutex;

      Ref<LoaderJob> loaderJob;
      Ref<const Loader::Contents> contents;

      void setContents(Ref<const Loader::Contents> c);

      void killLoaderJob();

      bool urlAssign(const vector<string> &, const Time &);

      virtual Loader::UriType getUriType() const = 0;
    };

    struct SubSceneNode: virtual ChildNode
    {
      static const NodeType *type;

      Ref<SceneBase> getSubScene() const;
      void setSubScene(Ref<SceneBase>);

      Ref<SceneBase> getSubSceneNoLock() const { return subScene; }

    protected:
      SubSceneNode() {}

      Ref<SceneBase> subScene;

      void refForwardDestroy();
    };

    struct Inline: SubSceneNode, UrlObject
    {
      static Ref<NodeBase> instantiate(BackRef<ExecutionContext> c)
      {
        return new Inline(c);
      }

      static const NodeType *type;
      const NodeType *getType() const { return type; }

      Inline(BackRef<ExecutionContext> c): NodeBase(c) {}

    private:
      friend void initializeNetworkComponent();

      bool load;

      EventSource loadChanged;

      Time loadStamp;

      Loader::UriType getUriType() const
      {
        return Loader::uriType_X3D;
      }

      bool loadAssign(const bool &, const Time &);

      void onLoaded(); // Overriding from UrlObject
      void clear(); // Overriding from UrlObject
    };

    struct ApplicationLink: SubSceneNode
    {
      static Ref<NodeBase> instantiate(BackRef<ExecutionContext> c)
      {
        return new ApplicationLink(c);
      }

      static const NodeType *type;
      const NodeType *getType() const { return type; }

      ApplicationLink(BackRef<ExecutionContext> c): NodeBase(c) {}

    private:
      friend void initializeNetworkComponent();

      // string dump(int level) const;
    };
  }
}

#endif // ARCHON_X3D_NETWORK_H

---