agent.h

/*
 *  Copyright (c) 2005-2007    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED_SCOPIRA_AGENT_AGENT_H__
#define __INCLUDED_SCOPIRA_AGENT_AGENT_H__

#include <typeinfo>

#include <scopira/basekit/narray.h>
#include <scopira/tool/object.h>
#include <scopira/tool/uuid.h>
#include <scopira/tool/bufferflow.h>
#include <scopira/tool/export.h>
#include <scopira/agent/task.h>

namespace scopira
{
  namespace agent
  {
    class uuid_query;
    class agenterror_reactor_i;
    class taskmsg_reactor_i;
    class agent_i;
  }
}

class scopira::agent::uuid_query
{
  public:
    SCOPIRA_EXPORT uuid_query(void);
    SCOPIRA_EXPORT explicit uuid_query(scopira::tool::uuid simplecase);

    SCOPIRA_EXPORT bool query(scopira::tool::uuid testid) const;

    //
    // The expression building operations.
    //

    SCOPIRA_EXPORT uuid_query & match_any(void);
    SCOPIRA_EXPORT uuid_query & match_one(scopira::tool::uuid id);
    SCOPIRA_EXPORT uuid_query & match_group(scopira::basekit::const_nslice<scopira::tool::uuid> ids);

    SCOPIRA_EXPORT uuid_query & op_and(void);
    SCOPIRA_EXPORT uuid_query & op_or(void);
    SCOPIRA_EXPORT uuid_query & op_xor(void);
    SCOPIRA_EXPORT uuid_query & op_not(void);

  private:
    scopira::tool::uuid dm_simpleuuid;
    // otherwise, this is the complex expression
    enum {
      match_any_c,    // this is basicaly a literal "true"
      match_one_c,   // + index
      match_group_c, // + index + size
      op_and_c,
      op_or_c,
      op_xor_c,
      op_not_c,
    };
    // the expression and its data
    std::vector<size_t> dm_exp;    // if this is empty, then use the simple case uuid
    std::vector<scopira::tool::uuid> dm_data;
};

class scopira::agent::agenterror_reactor_i
{
  public:
    virtual ~agenterror_reactor_i() { }
    SCOPIRA_EXPORT virtual void react_agenterror(scopira::agent::agent_i *a) = 0;
};

class scopira::agent::taskmsg_reactor_i
{
  public:
    virtual ~taskmsg_reactor_i() { }

    SCOPIRA_EXPORT virtual void react_taskmsg(scopira::agent::agent_i *a, scopira::tool::uuid srcid, scopira::tool::uuid destid) = 0;
};

class scopira::agent::agent_i : public scopira::tool::object
{
  public:
    static agent_i * instance(void) { return dm_instance; }

    SCOPIRA_EXPORT static agent_i * new_agent(void);
    SCOPIRA_EXPORT static bool get_cluster_server_url(std::string &serverurl);

    SCOPIRA_EXPORT virtual ~agent_i();

    SCOPIRA_EXPORT virtual void notify_stop(void) = 0;
    SCOPIRA_EXPORT virtual void wait_stop(void) = 0;
    SCOPIRA_EXPORT virtual void enqueue_network_quit(void) = 0;

    SCOPIRA_EXPORT virtual bool failed(void) const = 0;

    SCOPIRA_EXPORT virtual void set_agenterror_reactor(agenterror_reactor_i *r) = 0;

    SCOPIRA_EXPORT virtual void reg_context(scopira::tool::uuid &ctxid, taskmsg_reactor_i *reac) = 0;
    SCOPIRA_EXPORT virtual void unreg_context(scopira::tool::uuid ctxid) = 0;

    SCOPIRA_EXPORT virtual int find_services(scopira::tool::uuid &serviceid, scopira::basekit::narray<scopira::tool::uuid> &out) = 0;

    SCOPIRA_EXPORT virtual int universe_size(void) = 0;
    SCOPIRA_EXPORT virtual scopira::tool::uuid get_agent_id(void) = 0;

    SCOPIRA_EXPORT virtual scopira::tool::uuid launch_task(const std::type_info &t, scopira::tool::uuid where) = 0;
    SCOPIRA_EXPORT virtual scopira::tool::uuid launch_group(int numps, const std::type_info &t) = 0;
    SCOPIRA_EXPORT virtual void launch_slaves(scopira::tool::uuid masterid, int numtotalps, const std::type_info &t,
      scopira::basekit::narray<scopira::tool::uuid> &peers) = 0;
    SCOPIRA_EXPORT virtual void kill_task(scopira::tool::uuid ps) = 0;
    SCOPIRA_EXPORT virtual bool wait_task(scopira::tool::uuid ps, int msec) = 0;
    SCOPIRA_EXPORT virtual bool is_alive_task(scopira::tool::uuid ps) = 0;    // only designed for checking the "this" class
    SCOPIRA_EXPORT virtual bool is_killed_task(scopira::tool::uuid ps) = 0;

    SCOPIRA_EXPORT virtual bool wait_msg(const uuid_query &srcq, scopira::tool::uuid &foundsrc,  scopira::tool::uuid dest, int timeout) = 0;
    SCOPIRA_EXPORT virtual void send_msg(scopira::tool::uuid src, scopira::tool::uuid dest, scopira::tool::bufferflow *buf) = 0;
    // service broadcast ONLY (will be removed eventually?)
    SCOPIRA_EXPORT virtual void send_msg_bcast(scopira::tool::uuid src, scopira::tool::uuid destserviceid, scopira::tool::bufferflow *buf) = 0;
    // src will be filled with the actual source, after
    SCOPIRA_EXPORT virtual void recv_msg(const uuid_query &srcq, scopira::tool::uuid &foundsrc, scopira::tool::uuid dest, scopira::tool::count_ptr<scopira::tool::bufferflow> &buf) = 0;

  protected:
    SCOPIRA_EXPORT agent_i(void);

  private:
    SCOPIRA_EXPORT static agent_i *dm_instance;
};

#endif