framework/public/include/module.h

/**
 *Licensed to the Apache Software Foundation (ASF) under one
 *or more contributor license agreements.  See the NOTICE file
 *distributed with this work for additional information
 *regarding copyright ownership.  The ASF licenses this file
 *to you 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.
 */
/*
 * module.h
 *
 *  \date       Jul 12, 2010
 *  \author    	<a href="mailto:dev@celix.apache.org">Apache Celix Project Team</a>
 *  \copyright	Apache License, Version 2.0
 */

#ifndef MODULE_H_
#define MODULE_H_

typedef struct module *module_pt;

#include "celixbool.h"
#include "linked_list.h"
#include "manifest.h"
#include "version.h"
#include "array_list.h"
#include "bundle.h"
#include "framework_exports.h"

module_pt module_create(manifest_pt headerMap, const char* moduleId, bundle_pt bundle);
module_pt module_createFrameworkModule(bundle_pt bundle);
void module_destroy(module_pt module);

FRAMEWORK_EXPORT unsigned int module_hash(void * module);
FRAMEWORK_EXPORT int module_equals(void * module, void * compare);

FRAMEWORK_EXPORT wire_pt module_getWire(module_pt module, const char* serviceName);

FRAMEWORK_EXPORT version_pt module_getVersion(module_pt module);
FRAMEWORK_EXPORT celix_status_t module_getSymbolicName(module_pt module, const char** symbolicName);
FRAMEWORK_EXPORT char * module_getId(module_pt module);
FRAMEWORK_EXPORT linked_list_pt module_getWires(module_pt module);
FRAMEWORK_EXPORT void module_setWires(module_pt module, linked_list_pt wires);
FRAMEWORK_EXPORT bool module_isResolved(module_pt module);
FRAMEWORK_EXPORT void module_setResolved(module_pt module);
FRAMEWORK_EXPORT bundle_pt module_getBundle(module_pt module);

FRAMEWORK_EXPORT linked_list_pt module_getRequirements(module_pt module);
FRAMEWORK_EXPORT linked_list_pt module_getCapabilities(module_pt module);

FRAMEWORK_EXPORT array_list_pt module_getDependentImporters(module_pt module);
FRAMEWORK_EXPORT void module_addDependentImporter(module_pt module, module_pt importer);
FRAMEWORK_EXPORT void module_removeDependentImporter(module_pt module, module_pt importer);

FRAMEWORK_EXPORT array_list_pt module_getDependentRequirers(module_pt module);
FRAMEWORK_EXPORT void module_addDependentRequirer(module_pt module, module_pt requirer);
FRAMEWORK_EXPORT void module_removeDependentRequirer(module_pt module, module_pt requirer);

FRAMEWORK_EXPORT array_list_pt module_getDependents(module_pt module);

#endif /* MODULE_H_ */