github.com/matrixorigin/matrixone@v1.2.0/pkg/vm/engine/tae/iface/txnif/cmd.go (about)

     1  // Copyright 2021 Matrix Origin
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package txnif
    16  
    17  import (
    18  	"fmt"
    19  )
    20  
    21  type TxnCmd interface {
    22  	MarshalBinary() ([]byte, error)
    23  	UnmarshalBinary([]byte) error
    24  	GetType() uint16
    25  	Desc() string
    26  	String() string
    27  	ApplyRollback()
    28  	ApplyCommit()
    29  	SetReplayTxn(AsyncTxn)
    30  	VerboseString() string
    31  	Close()
    32  }
    33  
    34  type CmdFactory func(int16) TxnCmd
    35  
    36  var cmdFactories = map[int16]CmdFactory{}
    37  
    38  func RegisterCmdFactory(cmdType int16, factory CmdFactory) {
    39  	_, ok := cmdFactories[cmdType]
    40  	if ok {
    41  		panic(fmt.Sprintf("duplicate cmd type: %d", cmdType))
    42  	}
    43  	cmdFactories[cmdType] = factory
    44  }
    45  
    46  func GetCmdFactory(cmdType int16) (factory CmdFactory) {
    47  	factory = cmdFactories[cmdType]
    48  	if factory == nil {
    49  		panic(fmt.Sprintf("no factory found for cmd: %d", cmdType))
    50  	}
    51  	return
    52  }
    53  
    54  type CmdType uint16
    55  
    56  const (
    57  	CmdInvalid CmdType = iota
    58  	CmdPrepare
    59  	CmdCommit
    60  	CmdRollback
    61  	Cmd1PC
    62  	CmdSnapshot
    63  )