GAT Documentation

00001 /** @file resourcebroker.h
00002  *  Header file for the sample ResourceBroker CPI provider.
00003  *
00004  *  @date Thu Oct 23 2003
00005  *
00006  *  @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/resourcebroker/resourcebroker.h,v 1.4 2004/04/26 12:29:57 hartmutkaiser Exp $
00007  *
00008  *  Copyright (C) Hartmut Kaiser
00009  *  This file is part of the GAT Engine.
00010  *  Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>.
00011  *
00012  *  Use, modification and distribution is subject to the Gridlab Software
00013  *  License. (See accompanying file GLlicense.txt or copy at
00014  *  http://www.gridlab.org/GLlicense.txt)
00015  */
00016  
00017 #if !defined(_RESOURCEBROKER_H_)
00018 #define _RESOURCEBROKER_H_
00019 
00020 #ifdef __cplusplus
00021 extern "C" {
00022 #endif
00023 
00024 /* Register the ResourceBroker CPI */
00025 GATResult resourcebroker_adaptor_Register_GATResourceBrokerCPI(
00026   GATContext error_context, GATRegistry registry, 
00027   GATTable_const system_config, GATTable_const instance_config, void *token);
00028 
00029 /* Return the preferences, which allow to connect to this adaptor */
00030 GATResult resourcebroker_adaptor_MyPreferences(GATContext context, 
00031     GATPreferences *prefs);
00032 
00033 /* create a sample RMS jobID */
00034 GATResult resourcebroker_adaptor_make_sample_jobid(GATString_const vo_name,
00035   GATString *new_job_id);
00036 
00037 /* create a hardware resource description describing the existing job 
00038    environment */
00039 GATResourceDescription
00040   resourcebroker_adaptor_CreateHardwareResourceDescription(void);
00041 
00042 /*  The function resourcebroker_adaptor_CreateResource creates a new 
00043  *  GATResource for the given resource description (which should match the 
00044  *  local hardware).
00045  */
00046 GATResult
00047 resourcebroker_adaptor_CreateResource(GATContext context, 
00048   GATResourceDescription rd, GATResource *resource);
00049 
00050 #ifdef __cplusplus
00051 } /* extern "C" */
00052 #endif
00053 
00054 #endif /* !defined(_RESOURCEBROKER_H_) */
00055