Rosetta 3.4
Public Member Functions | Protected Member Functions | Friends
protocols::jd2::ShuffleFileSystemJobDistributor Class Reference

#include <ShuffleJobDistributor.hh>

Inheritance diagram for protocols::jd2::ShuffleFileSystemJobDistributor:
Inheritance graph
[legend]
Collaboration diagram for protocols::jd2::ShuffleFileSystemJobDistributor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~ShuffleFileSystemJobDistributor ()
 dtor WARNING WARNING! SINGLETONS' DESTRUCTORS ARE NEVER CALLED IN MINI! DO NOT TRY TO PUT THINGS IN THIS FUNCTION! here's a nice link explaining why: http://www.research.ibm.com/designpatterns/pubs/ph-jun96.txt
virtual core::Size get_new_job_id ()
 dummy for master/slave version
virtual void mark_current_job_id_for_repetition ()
 this function is called whenever a job "soft-fails" and needs to be retried. Generally it should ensure that the subsequent call to obtain_new_job returns this job over again.
core::Size next_random_job ()

Protected Member Functions

 ShuffleFileSystemJobDistributor ()
 ctor is protected; singleton pattern
virtual void handle_interrupt ()
 This function got called when job is not yet finished and got termitated abnormaly (ctrl-c, kill etc). when implimenting it in subclasses make sure to delete all in-progress-data that your job spawn.

Friends

class JobDistributorFactory

Constructor & Destructor Documentation

protocols::jd2::ShuffleFileSystemJobDistributor::ShuffleFileSystemJobDistributor ( ) [protected]

ctor is protected; singleton pattern

constructor. Notice it calls the parent class! It also builds some internal variables for determining which processor it is in MPI land.

protocols::jd2::ShuffleFileSystemJobDistributor::~ShuffleFileSystemJobDistributor ( ) [virtual]

dtor WARNING WARNING! SINGLETONS' DESTRUCTORS ARE NEVER CALLED IN MINI! DO NOT TRY TO PUT THINGS IN THIS FUNCTION! here's a nice link explaining why: http://www.research.ibm.com/designpatterns/pubs/ph-jun96.txt


Member Function Documentation

core::Size protocols::jd2::ShuffleFileSystemJobDistributor::get_new_job_id ( ) [virtual]
virtual void protocols::jd2::ShuffleFileSystemJobDistributor::handle_interrupt ( ) [inline, protected, virtual]

This function got called when job is not yet finished and got termitated abnormaly (ctrl-c, kill etc). when implimenting it in subclasses make sure to delete all in-progress-data that your job spawn.

Reimplemented from protocols::jd2::FileSystemJobDistributor.

void protocols::jd2::ShuffleFileSystemJobDistributor::mark_current_job_id_for_repetition ( ) [virtual]

this function is called whenever a job "soft-fails" and needs to be retried. Generally it should ensure that the subsequent call to obtain_new_job returns this job over again.

Reimplemented from protocols::jd2::FileSystemJobDistributor.

Reimplemented in protocols::jd2::BOINCJobDistributor.

core::Size protocols::jd2::ShuffleFileSystemJobDistributor::next_random_job ( ) [inline]

Friends And Related Function Documentation

friend class JobDistributorFactory [friend]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines