BCP_message.hpp

Go to the documentation of this file.

// Copyright (C) 2000, International Business Machines
// Corporation and others.  All Rights Reserved.
#ifndef _BCP_MESSAGE_H
#define _BCP_MESSAGE_H

// This file is fully docified.

#include <utility>

#include "BCP_string.hpp"
#include "BCP_message_tag.hpp"
#include "BCP_vector.hpp"

//#############################################################################

class BCP_buffer;
class USER_initialize;

//#############################################################################

const int BCP_AnyProcess = -1;

class BCP_message_environment{
public:
    virtual ~BCP_message_environment() {}
    virtual int register_process(USER_initialize* user_init) = 0;
    virtual int parent_process() = 0;
    virtual bool alive(const int pid) = 0;
    virtual const int* alive(int num, const int* pids) = 0;
    virtual void send(const int target, const BCP_message_tag tag) = 0;
    virtual void send(const int target, const BCP_message_tag tag,
                      const BCP_buffer& buf) = 0;
    virtual void multicast(int num, const int* targets,
                           const BCP_message_tag tag) = 0;
    virtual void multicast(int num, const int* targets,
                           const BCP_message_tag tag,
                           const BCP_buffer& buf) = 0;
    // blocking receive w/ timeout (ms??) from given source given msgtag (can
    // give wildcard anymsg, anyproc)

    virtual void receive(const int source,
                         const BCP_message_tag tag, BCP_buffer& buf,
                         const double timeout) = 0;
    virtual bool probe(const int source, const BCP_message_tag tag) = 0; 
    virtual int start_process(const BCP_string& exe,
                              const bool debug) = 0;
    virtual int start_process(const BCP_string& exe,
                              const BCP_string& machine,
                              const bool debug) = 0;
    virtual bool start_processes(const BCP_string& exe,
                                 const int proc_num,
                                 const bool debug,
                                 int* ids) = 0;
    virtual bool start_processes(const BCP_string& exe,
                                 const int proc_num,
                                 const BCP_vec<BCP_string>& machines,
                                 const bool debug,
                                 int* ids) = 0;
    virtual int num_procs() { return 0; }
    //    virtual void stop_process(int process) = 0;
    //    virtual void stop_processes(BCP_proc_array& processes) = 0;
};

#endif