/*
 *
  ***** BEGIN LICENSE BLOCK *****
 
  Copyright (C) 2009-2017 Olof Hagsand and Benny Holmgren

  This file is part of CLIXON.

  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.

  Alternatively, the contents of this file may be used under the terms of
  the GNU General Public License Version 3 or later (the "GPL"),
  in which case the provisions of the GPL are applicable instead
  of those above. If you wish to allow use of your version of this file only
  under the terms of the GPL, and not to allow others to
  use your version of this file under the terms of Apache License version 2, 
  indicate your decision by deleting the provisions above and replace them with
  the  notice and other provisions required by the GPL. If you do not delete
  the provisions above, a recipient may use your version of this file under
  the terms of any one of the Apache License version 2 or the GPL.

  ***** END LICENSE BLOCK *****

  */

#ifndef _BACKEND_PLUGIN_H_
#define _BACKEND_PLUGIN_H_

/*
 * Types
 */

/*! Transaction data
 * Clicon internal, presented as void* to app's callback in the 'transaction_data'
 * type in clicon_backend_api.h
 * XXX: move to .c file?
 */
typedef struct {
    uint64_t   td_id;       /* Transaction id */
    void      *td_arg;      /* Callback argument */
    cxobj     *td_src;      /* Source database xml tree */
    cxobj     *td_target;   /* Target database xml tree */
    cxobj    **td_dvec;     /* Delete xml vector */
    size_t     td_dlen;     /* Delete xml vector length */
    cxobj    **td_avec;     /* Add xml vector */
    size_t     td_alen;     /* Add xml vector length */
    cxobj    **td_scvec;    /* Source changed xml vector */
    cxobj    **td_tcvec;    /* Target changed xml vector */
    size_t     td_clen;     /* Changed xml vector length */
} transaction_data_t;

/*
 * Prototypes
 */
int  backend_plugin_init(clicon_handle h);
int  plugin_initiate(clicon_handle h); 
int  plugin_finish(clicon_handle h);

int  plugin_reset_state(clicon_handle h, char *dbname);
int  plugin_start_hooks(clicon_handle h, int argc, char **argv);

transaction_data_t * transaction_new(void);
int transaction_free(transaction_data_t *);

int  plugin_transaction_begin(clicon_handle h, transaction_data_t *td);
int  plugin_transaction_validate(clicon_handle h, transaction_data_t *td);
int  plugin_transaction_complete(clicon_handle h, transaction_data_t *td);
int  plugin_transaction_commit(clicon_handle h, transaction_data_t *td);
int  plugin_transaction_end(clicon_handle h, transaction_data_t *td);
int  plugin_transaction_abort(clicon_handle h, transaction_data_t *td);

#endif  /* _BACKEND_PLUGIN_H_ */