pstat/base/base.h

0001 /*
0002  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
0003  *                         University Research and Technology
0004  *                         Corporation.  All rights reserved.
0005  * Copyright (c) 2004-2006 The University of Tennessee and The University
0006  *                         of Tennessee Research Foundation.  All rights
0007  *                         reserved.
0008  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
0009  *                         University of Stuttgart.  All rights reserved.
0010  * Copyright (c) 2004-2005 The Regents of the University of California.
0011  *                         All rights reserved.
0012  * Copyright (c) 2007-2020 Cisco Systems, Inc.  All rights reserved
0013  * Copyright (c) 2019      Intel, Inc.  All rights reserved.
0014  * Copyright (c) 2021      Nanook Consulting.  All rights reserved.
0015  * $COPYRIGHT$
0016  *
0017  * Additional copyrights may follow
0018  *
0019  * $HEADER$
0020  *
0021  */
0022
0023 #ifndef PMIX_PSTAT_BASE_H
0024 #define PMIX_PSTAT_BASE_H
0025
0026 #include "pmix_config.h"
0027 #include "src/mca/base/pmix_mca_base_framework.h"
0028 #include "src/mca/pstat/pstat.h"
0029
0030 /*
0031  * Global functions for MCA overall pstat open and close
0032  */
0033
0034 BEGIN_C_DECLS
0035
0036 /**
0037  * Framework structure declaration for this framework
0038  */
0039 PMIX_EXPORT extern pmix_mca_base_framework_t pmix_pstat_base_framework;
0040
0041 /**
0042  * Select an available component.
0043  *
0044  * @return PMIX_SUCCESS Upon success.
0045  * @return PMIX_NOT_FOUND If no component can be selected.
0046  * @return PMIX_ERROR Upon other failure.
0047  *
0048  * At the end of this process, we'll either have a single
0049  * component that is selected and initialized, or no component was
0050  * selected.  If no component was selected, subsequent invocation
0051  * of the pstat functions will return an error indicating no data
0052  * could be obtained
0053  */
0054 PMIX_EXPORT int pmix_pstat_base_select(void);
0055
0056 PMIX_EXPORT extern pmix_pstat_base_component_t *pmix_pstat_base_component;
0057
0058 END_C_DECLS
0059
0060 #endif /* PMIX_BASE_PSTAT_H */