File method_scan.hpp¶

File List > cubrid > src > method > method_scan.hpp
/*
 *
 * Copyright 2016 CUBRID Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

#ifndef _METHOD_SCAN_HPP_
#define _METHOD_SCAN_HPP_

#ident "$Id$"

#if !defined (SERVER_MODE) && !defined (SA_MODE)
#error Belongs to server module
#endif /* !defined (SERVER_MODE) && !defined (SA_MODE) */

#include <functional>
#include <vector>

#include "dbtype_def.h" /* DB_VALUE */

#include "method_invoke_group.hpp" /* cubmethod::method_invoke_group */
#include "object_domain.h" /* TP_DOMAIN */
#include "query_list.h" /* qfile_list_id, qfile_list_scan_id */

#if defined (SA_MODE)
#include "query_method.hpp"
#endif

/* forward declarations */
struct val_list_node;
struct qproc_db_value_list;

// thread_entry.hpp
namespace cubthread
{
  class entry;
}

namespace cubscan
{
  namespace method
  {
    class scanner
    {
      public:

    void constructor();

    int init (cubthread::entry *thread_p, PL_SIGNATURE_ARRAY_TYPE *sig_array, qfile_list_id *list_id);
    void clear (bool is_final);

// Main SCAN routines

    int open ();
    SCAN_CODE next_scan (val_list_node &vl);
    int close ();

// Value array (Output structure to scan manager) declarations

      protected:

    int open_value_array ();
    void next_value_array (val_list_node &vl);
    int close_value_array ();

// argument declarations

    SCAN_CODE get_single_tuple ();

      private:

    cubthread::entry *m_thread_p; /* thread entry */
    cubmethod::method_invoke_group *m_method_group; /* method invoke implementations */

    qfile_list_id *m_list_id;       /* list file from cselect */
    qfile_list_scan_id m_scan_id;   /* for scanning list file */

    int m_arg_count;
    TP_DOMAIN **m_arg_dom_vector; /* arg value's domain */
    DB_VALUE *m_arg_vector;        /* arg value */

    qproc_db_value_list *m_dbval_list; /* result */
    };
  }
} // namespace cubscan

// naming convention of SCAN_ID's
using METHOD_SCAN_ID = cubscan::method::scanner;

#endif // _METHOD_SCAN_HPP_