gc_job_manager.h File Reference

#include <boost/utility.hpp>
#include <boost/shared_ptr.hpp>
#include <vector>
#include <string>
#include <stdexcept>
#include <libspe2.h>
#include "gc_job_desc.h"

Include dependency graph for gc_job_manager.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	gc_jm_options
class	gc_exception
class	gc_unknown_proc
class	gc_bad_alloc
class	gc_bad_align
class	gc_bad_submit
class	gc_job_manager
	Abstract class that manages SPE jobs.There is typically a single instance derived from this class. It is safe to call its methods from any thread. More...
Enumerations
enum	gc_wait_mode { GC_WAIT_ANY, GC_WAIT_ALL }
Functions
spe_program_handle_sptr	gc_program_handle_from_filename (const std::string &filename)
	Return a boost::shared_ptr to an spe_program_handle_t.
spe_program_handle_sptr	gc_program_handle_from_address (spe_program_handle_t *handle)
	Return a boost::shared_ptr to an spe_program_handle_t.
const std::string	gc_job_status_string (gc_job_status_t status)
	map gc_job_status_t into a string
gc_job_manager_sptr	gc_make_job_manager (const gc_jm_options *options=0)

---

Enumeration Type Documentation

enum gc_wait_mode

Enumerator:

GC_WAIT_ANY
GC_WAIT_ALL

---

Function Documentation

const std::string gc_job_status_string

(

gc_job_status_t

status

)

map gc_job_status_t into a string

gc_job_manager_sptr gc_make_job_manager

(

const gc_jm_options *

options = 0

)

spe_program_handle_sptr gc_program_handle_from_address

(

spe_program_handle_t *

handle

)

Return a boost::shared_ptr to an spe_program_handle_t.

Parameters:

handle

is a non-zero pointer to an embedded SPE image.

If successful returns a boost::shared_ptr that does nothing when it's time to free the object.

See also:

gc_program_handle_from_filename

spe_program_handle_sptr gc_program_handle_from_filename

(

const std::string &

filename

)

Return a boost::shared_ptr to an spe_program_handle_t.

Parameters:

filename

is the name of the SPE ELF executable to open.

Calls spe_image_open to open the file. If successful returns a boost::shared_ptr that will call spe_image_close when it's time to free the object.

Returns the equivalent of the NULL pointer if the file cannot be opened, or if it's not an SPE ELF object file.

See also:

gc_program_handle_from_address