FDO API Reference

Feature Data Objects

ConnectionManager.h

Go to the documentation of this file.

#ifndef _FDOCONNECTIONMANAGER_H_
#define _FDOCONNECTIONMANAGER_H_
/***************************************************************************

//
// Copyright (C) 2004-2006  Autodesk, Inc.
// 
// This library is free software; you can redistribute it and/or
// modify it under the terms of version 2.1 of the GNU Lesser
// General Public License as published by the Free Software Foundation.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//


 ***************************************************************************/
#ifdef _WIN32
#pragma once
#endif

#include <map>
#include <Fdo/IConnectionManager.h>

#ifdef _WIN32
typedef std::map <std::wstring, HMODULE> FdoModuleMap;
#else
typedef std::map <std::wstring, void *> FdoModuleMap;
#endif

/// \brief
///  
/// The IConnectionManager interface supports dynamic creation of connection objects 
/// given a provider name. Derives from IConnectionManager interface.
/// \remarks
///  
/// In order for dynamic creation to work, each dynamic link library, shared library, 
/// or assembly that implements a provider must supply a well-defined entry point function that 
/// takes as input a provider name and returns an FdoIConnection instance. The definition of the 
/// entry point function is language- and platform-dependent. For this release of FDO, the 
/// windows libraries supporting FDO providers will be expected to support the following well-known 
/// entry point function, which will create and return an unitialized connection object:
///        IConnection * CreateConnection();
class FdoConnectionManager : public IConnectionManager
{
    /// \brief
    /// Instances of interface FdoFeatureAccessManager are responsible for the 
    /// lifespan of FdoConnectionManager
    /// 
    friend class FdoFeatureAccessManager;

protected:
/// \cond DOXYGEN-IGNORE
    /// Constructs a default instance of a FdoProviderRegistry object.
    FdoConnectionManager();

    /// Default destructor for FdoProviderRegistry object.
    virtual ~FdoConnectionManager();

    virtual void Dispose();
/// \endcond

public:
    /// \brief
    /// Creates an unitialized connection object given the provider name 
    /// 
    /// \param providerName 
    /// The unique name of the feature provider. This name should be of the form 
    /// [Company].[Provider].[Version].
    /// 
    /// \return
    /// Returns an instance of an FdoIConnection object. 
    /// Throws an instance of FdoClientServicesException * if an error occurs.
    /// 
    FDO_API virtual FdoIConnection* CreateConnection(const wchar_t* providerName);
    
    /// \brief
    /// Frees a connection library reference given the provider name 
    /// 
    /// \param providerName 
    /// The unique name of the feature provider. This name should be of the form 
    /// [Company].[Provider].[Version].
    /// 
    /// \return
    /// Returns nothing. Throws an instance of FdoClientServicesException * if an error occurs.
    /// 
    FDO_API virtual void FreeLibrary(const wchar_t* providerName);

private:
    /// Provider library reference map
    FdoModuleMap m_moduleMap;
};
#endif

---

Comments or suggestions? Send us feedback.