Package convex.core.transactions

Class Multi

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<MapEntry<Keyword,ACell>>

convex.core.data.ADataStructure<MapEntry<Keyword,ACell>>

convex.core.data.AMap<Keyword,ACell>

convex.core.data.ARecord

convex.core.transactions.ATransaction

convex.core.transactions.Multi

All Implemented Interfaces:

IAssociative<Keyword,ACell>, IValidated, IWriteable, Map<Keyword,ACell>

public class Multi
extends ATransaction

The Multi class enables multiple child transactions to be grouped into a single wrapper transaction with useful joint execution semantics. Important notes: - Child transactions must either have the same origin address, or be for accounts controlled by the top level origin Address - Sequence numbers on child transactions are ignored - All transactions currently share the same juice limit / memory allowance

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MODE_ALL	Mode to execute all transactions iff all succeed.
static final int	MODE_ANY	Mode to execute and report all transactions, regardless of outcome.
static final int	MODE_FIRST	Mode to execute up to the first transaction succeeds.
static final int	MODE_UNTIL	Mode to execute until the transaction fails.
protected Ref<AVector<ATransaction>>	txs

Fields inherited from class convex.core.transactions.ATransaction

origin, sequence, UNKNOWN_SEQUENCE

Fields inherited from class convex.core.data.ARecord

DEFAULT_VALUE

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Multi(Address origin, long sequence, int mode, Ref<AVector<ATransaction>> txs)

Method Summary

Modifier and Type	Method	Description
Context	apply(Context ctx)	Applies the functional effect of this transaction to the current state.
static Multi	create(Address origin, long sequence, int mode, ATransaction... txs)
int	encode(byte[] bs, int pos)	Writes this transaction to a byte array, including the message tag
int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte.
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
ACell	get(Keyword key)	Gets the record field content for a given key, or null if not found.
RecordFormat	getFormat()	Gets the RecordFormat instance that describes this Record's layout
int	getMode()
<R extends ACell> Ref<R>	getRef(int i)	Gets a numbered child Ref from within this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
byte	getTag()	Gets the tag byte for this record type.
static Multi	read(Blob b, int pos)
Multi	updateRefs(IRefFunction func)	Updates all Refs in this object using the given function.
void	validateCell()	Validates the local structure and invariants of this cell.
ATransaction	withOrigin(Address newAddress)	Updates this transaction with the specified origin address
ATransaction	withSequence(long newSequence)	Updates this transaction with the specified sequence number

Methods inherited from class convex.core.transactions.ATransaction

equals, getOrigin, getSequence, getType, isCanonical, isCVMValue

Methods inherited from class convex.core.data.ARecord

accumulateEntrySet, accumulateKeySet, accumulateValues, assoc, assocEntry, containsKey, containsValue, dissoc, dissoc, empty, entryAt, entrySet, forEach, get, getEntry, getEntryByHash, getKeyRefEntry, getKeys, getValuesArray, keySet, reduceEntries, reduceValues, toCanonical, toHashMap, values

Methods inherited from class convex.core.data.AMap

clear, conj, containsKey, containsKeyRef, containsValue, entryVector, filterValues, get, get, get, getElementRef, merge, print, put, putAll, remove, slice, slice

Methods inherited from class convex.core.data.ADataStructure

checkIndex, conjAll, count, isDataValue, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, hashCode, isEmbedded, toString, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Field Details

txs

protected Ref<AVector<ATransaction>> txs

MODE_ANY

public static final int MODE_ANY

Mode to execute and report all transactions, regardless of outcome. Equivalent to executing transactions independently.

See Also:

• Constant Field Values

MODE_ALL

public static final int MODE_ALL

Mode to execute all transactions iff all succeed. Will rollback state changes if any fail.

See Also:

• Constant Field Values

MODE_FIRST

public static final int MODE_FIRST

Mode to execute up to the first transaction succeeds. State changes resulting from the first successful transaction only will be applied.

See Also:

• Constant Field Values

MODE_UNTIL

public static final int MODE_UNTIL

Mode to execute until the transaction fails. Transactions beyond the first failure will not be attempted.

See Also:

• Constant Field Values

Constructor Details

Multi

protected Multi(Address origin,
 long sequence,
 int mode,
 Ref<AVector<ATransaction>> txs)

Method Details

create

public static Multi create(Address origin,
 long sequence,
 int mode,
 ATransaction... txs)

getMode

public int getMode()

encode

public int encode(byte[] bs,
 int pos)

Description copied from class: ATransaction

Writes this transaction to a byte array, including the message tag

Specified by:

encode in interface IWriteable

Specified by:

encode in class ATransaction

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, excluding the tag byte.

Overrides:

encodeRaw in class ATransaction

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

read

public static Multi read(Blob b,
 int pos)
                  throws BadFormatException

Throws:

BadFormatException

estimatedEncodingSize

public int estimatedEncodingSize()

Description copied from interface: IWriteable

Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is highly likely to contain the entire object when encoded, including the tag byte. Should not traverse soft Refs, i.e. must be usable on arbitrary partial data structures

Specified by:

estimatedEncodingSize in interface IWriteable

Specified by:

estimatedEncodingSize in class ATransaction

Returns:

The estimated size for the binary representation of this object.

apply

public Context apply(Context ctx)

Description copied from class: ATransaction

Applies the functional effect of this transaction to the current state. Important points:

• Assumes all relevant accounting preparation already complete, including juice reservation
• Performs complete state update (including any rollbacks from errors)
• Produces result, which may be exceptional
• Does not finalise memory/juice accounting (will be completed afterwards)

Specified by:

apply in class ATransaction

Parameters:

ctx - Context for which to apply this Transaction

Returns:

The updated Context

withSequence

public ATransaction withSequence(long newSequence)

Description copied from class: ATransaction

Updates this transaction with the specified sequence number

Specified by:

withSequence in class ATransaction

Parameters:

newSequence - New sequence number

Returns:

Updated transaction, or this transaction if the sequence number is unchanged.

withOrigin

public ATransaction withOrigin(Address newAddress)

Description copied from class: ATransaction

Updates this transaction with the specified origin address

Specified by:

withOrigin in class ATransaction

Parameters:

newAddress - New address

Returns:

Updated transaction, or this transaction if unchanged.

getTag

public byte getTag()

Description copied from class: ARecord

Gets the tag byte for this record type. The Tag is the byte used to identify the record in the binary encoding.

Specified by:

getTag in class ARecord

Returns:

Record tag byte

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

get

public ACell get(Keyword key)

Description copied from class: ARecord

Gets the record field content for a given key, or null if not found.

Specified by:

get in class ARecord

Parameters:

key - Key to look up in this record

Returns:

Field value for the given key

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell

getRef

public <R extends ACell> Ref<R> getRef(int i)

Description copied from class: ACell

Gets a numbered child Ref from within this Cell. WARNING: May need to convert to a canonical instance

Overrides:

getRef in class ACell

Type Parameters:

R - Type of referenced Cell

Parameters:

i - Index of ref to get

Returns:

The Ref at the specified index

updateRefs

public Multi updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Overrides:

updateRefs in class ACell

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

getFormat

public RecordFormat getFormat()

Description copied from class: ARecord

Gets the RecordFormat instance that describes this Record's layout

Specified by:

getFormat in class ARecord

Returns:

RecordFormat instance