xta_transaction.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2019, Christian Ferrari <tiian@users.sourceforge.net>
 * All rights reserved.
 *
 * This file is part of LIXA.
 *
 * LIXA is free software: you can redistribute this file and/or modify
 * it under the terms of the GNU Lesser General Public License version 2.1 as
 * published by the Free Software Foundation.
 *
 * LIXA 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with LIXA.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef XTA_TRANSACTION_H
# define XTA_TRANSACTION_H



/* XTA includes */
#include "xta_config.h"
#include "xta_xa_resource.h"



typedef void xta_transaction_client_status_t;



/*
 * This type is a declaration only statement: the real type is defined inside
 * XA Resource header file. Here we just need to store a pointer to
 * a XA Resource inside an XA Transaction.
 */
typedef struct xta_xa_resource_s xta_xa_resource_t;



typedef struct xta_transaction_s {
    int                              already_opened;
    int                              multiple_branches;
    xta_transaction_client_status_t *client_status;
    xta_config_t                    *local_ccc;
    xta_xid_t                       *xid;
    int                              commit_suspended;
} xta_transaction_t;



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */



    xta_transaction_t *xta_transaction_new(void);



    void xta_transaction_delete(xta_transaction_t *transact) DEPRECATED;



    int xta_transaction_safe_delete(const xta_transaction_t *transact);


    
    xta_config_t *xta_transaction_get_config(xta_transaction_t *transact);
    
    

    int xta_transaction_enlist_resource(xta_transaction_t *transact,
                                        xta_xa_resource_t *xa_res);
    

    int xta_transaction_open(xta_transaction_t *transact) DEPRECATED ;
    /*
     * Prepare the XA Resource Managers and the XA Transaction Manager for a
     * new transactional Unit of Work. From the XA specification point of view,
     * it calls xa_open (for the Native XA Resource Managers)
     * @param[in,out] transact : transaction object
     * @return a reason code
     */
    int xta_transaction_open_internal(xta_transaction_t *transact);


    
    int xta_transaction_close(xta_transaction_t *transact) DEPRECATED ;
    /*
     * Shut down the XA Resource Managers and the XA Transaction Manager after
     * transactional Unit of Work completion. From the XA specification point
     * of view, it calls xa_close (for the Native XA Resource Managers)
     * @param[in,out] transact : transaction object
     * @return a reason code
     */
    int xta_transaction_close_internal(xta_transaction_t *transact);
    
    

    int xta_transaction_recover(xta_transaction_t *transact);

    
    
    int xta_transaction_start(xta_transaction_t *transact,
                              int multiple_branches);


    
    int xta_transaction_commit(xta_transaction_t *transact, int non_blocking);

    
    
    int xta_transaction_rollback(xta_transaction_t *transact);

    
    
    int xta_transaction_redigest(xta_transaction_t *transact,
                                 const xta_xa_resource_config_t *xrc);

    

    int xta_transaction_suspend(xta_transaction_t *transact, long flags);
    

    
    int xta_transaction_resume(xta_transaction_t *transact,
                               const char *xid_string, long flags);
    

    
    int xta_transaction_branch(xta_transaction_t *transact,
                               const char *xid_string);
    

    
    const xta_xid_t *xta_transaction_get_xid(
        const xta_transaction_t *transact);



    int xta_transaction_get_multiple_branches(
        const xta_transaction_t *transact);

    
    
#ifdef __cplusplus
}
#endif /* __cplusplus */



#endif /* XTA_TRANSACTION_H */