PageRenderTime 21ms CodeModel.GetById 13ms app.highlight 3ms RepoModel.GetById 2ms app.codeStats 0ms

/gecko_sdk/idl/nsIServiceManager.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 113 lines | 24 code | 11 blank | 78 comment | 0 complexity | 011c4973dbab3e754e5e4e9ec57c5f18 MD5 | raw file
  1/* ***** BEGIN LICENSE BLOCK *****
  2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3 *
  4 * The contents of this file are subject to the Mozilla Public License Version
  5 * 1.1 (the "License"); you may not use this file except in compliance with
  6 * the License. You may obtain a copy of the License at
  7 * http://www.mozilla.org/MPL/
  8 *
  9 * Software distributed under the License is distributed on an "AS IS" basis,
 10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11 * for the specific language governing rights and limitations under the
 12 * License.
 13 *
 14 * The Original Code is XPCOM.
 15 *
 16 * The Initial Developer of the Original Code is Netscape Communications.
 17 * Portions created by the Initial Developer are Copyright (C) 2001
 18 * the Initial Developer. All Rights Reserved.
 19 *
 20 * Contributor(s):
 21 *
 22 * Alternatively, the contents of this file may be used under the terms of
 23 * either the GNU General Public License Version 2 or later (the "GPL"), or
 24 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 25 * in which case the provisions of the GPL or the LGPL are applicable instead
 26 * of those above. If you wish to allow use of your version of this file only
 27 * under the terms of either the GPL or the LGPL, and not to allow others to
 28 * use your version of this file under the terms of the MPL, indicate your
 29 * decision by deleting the provisions above and replace them with the notice
 30 * and other provisions required by the GPL or the LGPL. If you do not delete
 31 * the provisions above, a recipient may use your version of this file under
 32 * the terms of any one of the MPL, the GPL or the LGPL.
 33 *
 34 * ***** END LICENSE BLOCK ***** */
 35
 36
 37#include "nsISupports.idl"
 38
 39/**
 40 * The nsIServiceManager manager interface provides a means to obtain
 41 * global services in an application. The service manager depends on the 
 42 * repository to find and instantiate factories to obtain services.
 43 *
 44 * Users of the service manager must first obtain a pointer to the global
 45 * service manager by calling NS_GetServiceManager. After that, 
 46 * they can request specific services by calling GetService. When they are
 47 * finished they can NS_RELEASE() the service as usual.
 48 *
 49 * A user of a service may keep references to particular services indefinitely
 50 * and only must call Release when it shuts down.
 51 *
 52 * @status FROZEN
 53 */
 54
 55[scriptable, uuid(8bb35ed9-e332-462d-9155-4a002ab5c958)]
 56interface nsIServiceManager : nsISupports
 57{
 58    /**
 59     * getServiceByContractID
 60     *
 61     * Returns the instance that implements aClass or aContractID and the
 62     * interface aIID.  This may result in the instance being created.
 63     *
 64     * @param aClass or aContractID : aClass or aContractID of object 
 65     *                                instance requested
 66     * @param aIID : IID of interface requested
 67     * @param result : resulting service 
 68     */
 69    void getService(in nsCIDRef aClass, 
 70		    in nsIIDRef aIID, 
 71		    [iid_is(aIID),retval] out nsQIResult result);
 72
 73    void getServiceByContractID(in string aContractID,
 74				in nsIIDRef aIID, 
 75				[iid_is(aIID),retval] out nsQIResult result);
 76
 77    /**
 78     * isServiceInstantiated
 79     *
 80     * isServiceInstantiated will return a true if the service has already
 81     * been created, otherwise false
 82     *
 83     * @param aClass or aContractID : aClass or aContractID of object 
 84     *                                instance requested
 85     * @param aIID : IID of interface requested
 86     * @param aIID : IID of interface requested
 87     */
 88    boolean isServiceInstantiated(in nsCIDRef aClass, in nsIIDRef aIID);
 89    boolean isServiceInstantiatedByContractID(in string aContractID, in nsIIDRef aIID);
 90};
 91
 92
 93%{C++
 94#define NS_ERROR_SERVICE_NOT_AVAILABLE  NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_XPCOM, 22)
 95/**
 96 * @status DEPRECATED
 97 */
 98#define NS_ERROR_SERVICE_NOT_FOUND      NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_XPCOM, 22)
 99/**
100 * @status DEPRECATED
101 */
102#define NS_ERROR_SERVICE_IN_USE         NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_XPCOM, 23)
103
104// Observing xpcom autoregistration.  Topics will be 'start' and 'stop'.
105#define NS_XPCOM_AUTOREGISTRATION_OBSERVER_ID "xpcom-autoregistration"
106
107#ifdef MOZILLA_INTERNAL_API
108#include "nsXPCOM.h"
109#include "nsServiceManagerUtils.h"
110#include "nsIServiceManagerObsolete.h"
111#endif
112%}
113