usModule.h

Go to the documentation of this file.

/*============================================================================

  Library: CppMicroServices

  Copyright (c) German Cancer Research Center (DKFZ)
  All rights reserved.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

============================================================================*/


#ifndef USMODULE_H
#define USMODULE_H

#include "usModuleVersion.h"

#include <vector>

US_BEGIN_NAMESPACE

class Any;
class CoreModuleContext;
struct ModuleInfo;
class ModuleContext;
class ModuleResource;
class ModulePrivate;

template<class S>
class ServiceReference;

typedef ServiceReference<void> ServiceReferenceU;

class US_Core_EXPORT Module
{

public:

  static const std::string& PROP_ID();

  static const std::string& PROP_NAME();

  static const std::string& PROP_LOCATION();

  static const std::string& PROP_VERSION();

  static const std::string& PROP_VENDOR();

  static const std::string& PROP_DESCRIPTION();

  static const std::string& PROP_AUTOLOAD_DIR();

  static const std::string& PROP_AUTOLOADED_MODULES();

  ~Module();

  bool IsLoaded() const;

  ModuleContext* GetModuleContext() const;

  long GetModuleId() const;

  std::string GetLocation() const;

  std::string GetName() const;

  ModuleVersion GetVersion() const;

  Any GetProperty(const std::string& key) const;

  std::vector<std::string> GetPropertyKeys() const;

  std::vector<ServiceReferenceU> GetRegisteredServices() const;

  std::vector<ServiceReferenceU> GetServicesInUse() const;

  ModuleResource GetResource(const std::string& path) const;

  std::vector<ModuleResource> FindResources(const std::string& path, const std::string& filePattern, bool recurse) const;

private:

  friend class CoreModuleActivator;
  friend class ModuleRegistry;
  friend class ServiceReferencePrivate;

  ModulePrivate* d;

  Module();

  void Init(CoreModuleContext* coreCtx, ModuleInfo* info);
  void Uninit();

  void Start();
  void Stop();

  // purposely not implemented
  Module(const Module &);
  Module& operator=(const Module&);

};

US_END_NAMESPACE

US_Core_EXPORT std::ostream& operator<<(std::ostream& os, const US_PREPEND_NAMESPACE(Module)& module);
US_Core_EXPORT std::ostream& operator<<(std::ostream& os, US_PREPEND_NAMESPACE(Module) const * module);

#endif // USMODULE_H