Allup.idl

Go to the documentation of this file.

/*
 * Allup.idl
 *
 * Copyright (c) 2003 The University of Utah and the Flux Group.
 * All rights reserved.
 *
 * This file is licensed under the terms of the GNU Public License.  
 * See the file "license.terms" for restrictions on redistribution 
 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 */

/**
 * @file Allup.idl
 *
 * IDL for the all-in-one CPU broker server, allup.
 */

#ifndef _allup_idl
#define _allup_idl

module edu
{
    module utah
    {
        module pces
        {
            /**
             * String sequence used to pass command line arguments to the
             * FactoryLibrary.
             */
            typedef sequence<string> ArgV;

            /**
             * The FactoryLibrary interface provides a wrapper around shared
             * libraries that can communicate with CORBA objects.
             */
            interface FactoryLibrary
            {
                /**
                 * @return The name of this library.
                 */
                string Name();
                
                /**
                 * Interpret a 'hey' style command line.
                 *
                 * @sa HeyParser
                 *
                 * @param args The command line arguments that the library
                 * should act on.
                 * @param o String to send to standard output.
                 * @param e String to send to standard error.
                 */
                long Hey(in ArgV args, out string o, out string e);
            };

            /**
             * Sequence of FactoryLibrary objects.
             */
            typedef sequence<FactoryLibrary> FactoryLibraryList;

            /**
             * Exception raised when a library could not be found or loaded.
             */
            exception NoSuchLibrary {
                string name;    /**< The name of the library. */
                string message; /**< A description of the problem. */
            };

            /**
             * The main interface to the Allup server.  The primary role of
             * Allup is to hold shared libraries and service the CORBA objects
             * created from those libraries.
             */
            interface Allup
            {
                /**
                 * Open a library in the server.
                 *
                 * @param name The full path of the library.
                 * @return A FactoryLibrary object that can be used to
                 * communicate with the library.
                 *
                 * @exception NoSuchLibrary if the library could not be found
                 * or loaded.
                 */
                FactoryLibrary OpenLibrary(in string name)
                    raises(NoSuchLibrary);

                /**
                 * @return A list of libraries current open in the server.
                 */
                FactoryLibraryList Libraries();

                /**
                 * Shut down the server process.
                 */
                void Shutdown();
            };
        };
    };
};

#endif

---