/*
 * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution. 
 *
 *   This program is free software; you can redistribute it and/or modify 
 *   it under the terms of the GNU General Public License as published by 
 *   the Free Software Foundation; version 2 of the License. 
 *
 *  This program is distributed in the hope that it will be useful, 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
 *  GNU General Public License for more details. 
 *
 *  You should have received a copy of the GNU General Public License 
 *  along with this program; if not, write to the Free Software 
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 *
 */


/*
 * Public defines for value array scans
 */

#ifndef _METHOD_SCAN_H_
#define _METHOD_SCAN_H_

#ident "$Id$"

#include "db.h"
#include "dbtype.h"
#include "query_opfunc.h"
#ifndef SERVER_MODE
#include "work_space.h"
#include "cursor.h"
#endif /* SERVER_MODE */

#ifdef SERVER_MODE
#define VACOMM_BUFFER_SIZE 4096

typedef struct vacomm_buffer VACOMM_BUFFER;
struct vacomm_buffer
{				/*   */
  int length;			/* trans length */
  int status;			/* trans status */
  int error;			/* client error */
  int no_vals;			/* number of values */
  char *area;			/* buffer + header */
  char *buffer;			/* buffer */
  int cur_pos;			/* current position */
  int size;			/* size of buffer */
  int action;			/* client action */
};
#endif

#define MAX_XS_SCANBUF_DBVALS 256

typedef struct method_info METHOD_INFO;
struct method_info
{
  QFILE_LIST_ID *list_id;	/* list id for arguments */
  METHOD_SIG_LIST *method_sig_list;	/* method signatures */
};

typedef struct method_scan_buffer METHOD_SCAN_BUFFER;
struct method_scan_buffer
{				/* value array scanbuf */
  QPROC_DB_VALUE_LIST dbval_list;	/* ptrs into the value array */
  union
  {				/* ctl info based on type */
    METHOD_INFO method_ctl;
  } s;
#ifdef SERVER_MODE
  VACOMM_BUFFER *vacomm_buffer;
#else				/* SERVER_MODE */
  /* These are needed for calling      */
  /* methods in standalone mode        */
  DB_VALUE *vallist;		/* values from the input list file   */
  DB_VALUE **valptrs;		/* ptrs to the above values          */
  int val_cnt;			/* number of values in vallist       */
  int *oid_cols;		/* OID columns in list file          */
  CURSOR_ID crs_id;		/* cursor id                         */
#endif				/* SERVER_MODE */
};

extern int method_open_scan (THREAD_ENTRY * thread_p,
			     METHOD_SCAN_BUFFER * scan_buf,
			     QFILE_LIST_ID * list_id,
			     METHOD_SIG_LIST * method_sig_list);
extern int method_close_scan (THREAD_ENTRY * thread_p,
			      METHOD_SCAN_BUFFER * scan_buf);
extern SCAN_CODE method_scan_next (THREAD_ENTRY * thread_p,
				   METHOD_SCAN_BUFFER * scan_buf,
				   VAL_LIST * val_list);
#endif /* _METHOD_SCAN_H_ */