src/main/cms/XAResource.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 _CMS_XARESOURCE_H_
#define _CMS_XARESOURCE_H_

#include <cms/Config.h>

#include <cms/Xid.h>
#include <cms/XAException.h>

namespace cms {

    class CMS_API XAResource {
    public:

        static const int TMENDRSCAN;

        static const int TMFAIL;

        static const int TMJOIN;

        static const int TMNOFLAGS;

        static const int TMONEPHASE;

        static const int TMRESUME;

        static const int TMSTARTRSCAN;

        static const int TMSUCCESS;

        static const int TMSUSPEND;

        static const int XA_RDONLY;

        static const int XA_OK;

    public:

        virtual ~XAResource();

        virtual void commit( const Xid* xid, bool onePhase ) = 0;

        virtual void end( const Xid* xid, int flags ) = 0;

        virtual void forget( const Xid* xid ) = 0;

        virtual int getTransactionTimeout() const = 0;

        virtual bool isSameRM( const XAResource* theXAResource ) = 0;

        virtual int prepare( const Xid* xid ) = 0;

        virtual int recover(int flag, Xid** recovered ) = 0;

        virtual void rollback( const Xid* xid ) = 0;

        virtual bool setTransactionTimeout( int seconds ) = 0;

        virtual void start( const Xid* xid, int flags ) = 0;

    };

}

#endif /* _CMS_XARESOURCE_H_ */