/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2000-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * @(#)MemAllocTest.h	1.5 06/26/07
 */ 

#ifndef MEMALLOCTEST_H
#define MEMALLOCTEST_H

#ifdef __cplusplus
extern "C" {
#endif

#include "../cshim/mqtypes.h"


/** These functions are only used during testing.  Some are used to
 *  force a memory allocation failure, which exercises the code that
 *  cleans up when these types of failures occur.  Other functions
 *  are used to force the broker to shutdown to simulate the broker
 *  crashing. */
  

/** Sets the number of memory allocations that succeed before a memory
 *  allocation fails. */
EXPORTED_SYMBOL void
setAllocationsBeforeFailure(int allocationsBeforeFailure);

/** Sets the number of memory allocations before the broker is
 *  restarted.  The BROKER_RESTART_COMMAND constant located in
 *  MemAllocTest.cpp must be set correctly if this function is used.*/
EXPORTED_SYMBOL void
setAllocationsBeforeBrokerFailure(int allocationsBeforeBrokerFailure);

/** Gets the number of allocations since the last call to
 *  setAllocationsBeforeFailure */
EXPORTED_SYMBOL int
getCurrentAllocation();

/** Sets whether or not memory allocations fail after the first memory
 *  allocation fails. */
EXPORTED_SYMBOL void
setAllocationFailuresContinue(int allocationFailuresContinue);

/** Forces the next memory allocation to succeed no matter what (except
 *  if we are actually out of memory). */
EXPORTED_SYMBOL void  
nextAllocSucceeds();

/** Determines based on the current allocation and the values set for allocations
 *  before failure whether or not this malloc should succeed. */
EXPORTED_SYMBOL int
mallocSucceeds();

#ifdef __cplusplus
}
#endif

#endif /* MEMALLOCTEST_H */


