# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or  modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the GNU Affero General Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.

# Session Transaction Entry IDL File

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/db/logical_session_id.h"
        - "mongo/db/repl/optime.h"

imports:
    - "mongo/idl/basic_types.idl"
    - "mongo/db/logical_session_id.idl"

# TODO: SERVER-31278 import from repl/replication_types.idl instead
types:
    optime:
        bson_serialization_type: object
        description: A document representing an OpTime.
        cpp_type: "repl::OpTime"
        serializer: repl::OpTime::toBSON
        deserializer: repl::OpTime::parse

structs:
    sessionTxnRecord:
        description: "A document used for storing session transaction states."
        fields:
            _id:
                cpp_name: sessionId
                type: LogicalSessionId
                description: "The id of the session this transaction belongs to."
            txnNum:
                type: TxnNumber
                description: "The id representing this transaction."
            lastWriteOpTime:
                type: optime
                description: "The optime timestamp component of the last write on this
                              transaction."
            lastWriteDate:
                type: date
                description: "Wall clock time of the last write which happened on on this
                              transaction."