github.com/matrixorigin/matrixone@v0.7.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  	"io"
    20  )
    21  
    22  type TxnCmd interface {
    23  	WriteTo(io.Writer) (int64, error)
    24  	ReadFrom(io.Reader) (int64, error)
    25  	Marshal() ([]byte, error)
    26  	Unmarshal([]byte) error
    27  	GetType() int16
    28  	Desc() string
    29  	String() string
    30  	ApplyRollback()
    31  	ApplyCommit()
    32  	SetReplayTxn(AsyncTxn)
    33  	VerboseString() string
    34  	Close()
    35  }
    36  
    37  type CmdFactory func(int16) TxnCmd
    38  
    39  var cmdFactories = map[int16]CmdFactory{}
    40  
    41  func RegisterCmdFactory(cmdType int16, factory CmdFactory) {
    42  	_, ok := cmdFactories[cmdType]
    43  	if ok {
    44  		panic(fmt.Sprintf("duplicate cmd type: %d", cmdType))
    45  	}
    46  	cmdFactories[cmdType] = factory
    47  }
    48  
    49  func GetCmdFactory(cmdType int16) (factory CmdFactory) {
    50  	factory = cmdFactories[cmdType]
    51  	if factory == nil {
    52  		panic(fmt.Sprintf("no factory found for cmd: %d", cmdType))
    53  	}
    54  	return
    55  }
    56  
    57  type CmdType uint16
    58  
    59  const (
    60  	CmdInvalid CmdType = iota
    61  	CmdPrepare
    62  	CmdCommit
    63  	CmdRollback
    64  	Cmd1PC
    65  	CmdSnapshot
    66  )