src/engine/AppScopeHandlerPool.cpp

/* -*- C++ -*- */
/*
 *   Copyright 2003-2004 The Apache Software Foundation.
 *
 *   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.
 *
 * 
 * @author Susantha Kumara (skumara@virtusa.com)
 *
 */

// !!! This include file must be first thing in file !!!
#include "../platforms/PlatformAutoSense.hpp"

#include <axis/AxisException.hpp>

#include "AppScopeHandlerPool.h"
#include "HandlerLoader.h"

#include "../common/AxisTrace.h"

extern AXIS_CPP_NAMESPACE_PREFIX HandlerLoader* g_pHandlerLoader;

AXIS_CPP_NAMESPACE_START

/* this class does not do the object level blocking. Instead expects the 
 * thread level blocking and waiting by the caller thread.
 */ 
AppScopeHandlerPool::AppScopeHandlerPool ()
{

}

AppScopeHandlerPool::~AppScopeHandlerPool ()
{
    logEntryEngine("AppScopeHandlerPool::~AppScopeHandlerPool")

    for (map < int, list <BasicHandler*> >::iterator it =
        m_Handlers.begin (); it != m_Handlers.end (); it++)
    {
        for (list <BasicHandler*>::iterator itr = (*it).second.begin ();
            itr != (*it).second.end (); itr++)
        {
            g_pHandlerLoader->deleteHandler (*itr, (*it).first);
        }
        (*it).second.clear ();
    }
    m_Handlers.clear ();
    
    logExit() 
}

/* This method does not block the object. Instead expects that the calling 
 * thread MUST block itself and wait if the requested handler is not found.
 */

int AppScopeHandlerPool::getInstance (BasicHandler** pHandler, int nLibId)
{
    logEntryEngine("AppScopeHandlerPool::getInstance")
    
    Lock l(this);
    int Status = AXIS_SUCCESS;
    
    if (m_Handlers.find (nLibId) != m_Handlers.end ())
    {
        if (m_Handlers[nLibId].empty ())
            /* this means that the object is being used by some other thread
         * but we cannot create any more objects because this is an 
         * application scope object. So just return SERVER_ENGINE_HANDLERBEINGUSED
         */
        {
            logThrowException("AxisEngineException - SERVER_ENGINE_HANDLER_BEING_USED")
            
            throw AxisEngineException(SERVER_ENGINE_HANDLER_BEING_USED);
        }
        else
        {
            *pHandler = m_Handlers[nLibId].front ();
            m_Handlers[nLibId].pop_front ();
        }
    }
    else // Not even the handler DLL loaded
    {
        Status = g_pHandlerLoader->createHandler (pHandler, nLibId);
        if (AXIS_SUCCESS == Status)
        {
            /* This just creates the entry in m_Handlers so that next time we 
         * know that the DLL is loaded
         */ 
            m_Handlers[nLibId].clear ();
        }
    }
    
    logExitWithReturnCode(Status)
    
    return Status;
}

int AppScopeHandlerPool::putInstance (BasicHandler* pHandler, int nLibId)
{
    logEntryEngine("AppScopeHandlerPool::putInstance")

    Lock l(this);
    m_Handlers[nLibId].push_back (pHandler);

    logExitWithReturnCode(AXIS_SUCCESS)

    return AXIS_SUCCESS;
}

AXIS_CPP_NAMESPACE_END