Hemi.transactionHemi JavaScript FrameworkHemi JavaScript Framework Project/Hemi/Hemi.transactionHemiThe Transaction Service provides an object-level communication bus. Unlike events, delegates, and message subscriptions and publications, the transaction service coordinates disimilar objects on a common band. Non Framework Objects may be decorated with the Transaction Participant API, and allow cross-Framework coordination.serviceStatic instance of the serviceImpl class.3.1.9TransactionParticipantThis static class describes the interface an object must expose to participate in the TransactionService. A participant must be registered with the ObjectRegistry. The addServiceAPI method may be used to instrument this API for quick access to the service.doTransactionThe TransactionService object handling this transaction.The packet being served.Always returns false.Processes the served transaction packet.startTransactionThe TransactionService object handling this transaction.The packet for this transaction.Starts the transaction for the specified packet.endTransactionThe TransactionService object handling this transaction.The packet for this transaction.Ends the transaction for the specified packet.3.1.9TransactionPacket3.1.9This is an abstract class generated by the TransactionService. It has no public initializer or constructor.service_idThe unique identifier of the service to which this packet belongs.packet_idThe unique identifer of the packet.packet_nameThe name of the packet.participantsHash of object identifiers that are participating in the transaction for this packet. The hash key is the object identifier, and the hash value is the participant state. State values are: 0 = not participating / transaction ended, 1 = participating, 2 = participated and completed with a positive (true) response.participant_countNumber of participants currently using this packet.packet_stateVariable use property.serve_typeThe type of service this packet will receive. 1 indicates the packet will be served untill all participants return true from doTransaction. 2 indicates the packet is only served once.setBlockStartTransactionBit indicating whether the packet is blocked from being served during startTransaction.Specifies whether the packet should be served during startTransaction.setBlockServeTransactionBit indicating whether the packet is blocked from being served during serveTransaction.Specifies whether the packet should be served during serveTransaction.setBlockEndTransactionBit indicating whether the packet is blocked from being served during endTransaction.Specifies whether the packet should be served during endTransaction.setServeTypeThe type of service this packet will receive. 1 indicates the packet will be served untill all participants return true from doTransaction. 2 indicates the packet is only served once.Sets the packet serve type.is_openBit indicating whether the packet is open.is_finalizedBit indicating whether the packet has been finalized.errorsVariable use property.owner_idIdentifier of the registered object that owns the packet.dataThe packet data.transactionStatic instance of the serviceImpl class.3.1.9addServiceAPIObject onto which to inject helper methods for working with transactions.Bit indicating whether the service API was injected where otherwise not defined.Injects the required API for working with transactions onto the target object._handle_transactionThe TransactionService object handling this transaction.The packet being served.Processes the served transaction packet._handle_begin_transactionThe TransactionService object handling this transaction.The packet being served.Invoked when the transaction for the specified packet begins._handle_end_transactionThe TransactionService object handling this transaction.The packet being served.Invoked when the transaction for the specified packet ends._handle_packettypeThe TransactionService object handling this transaction.The packet being served.Processes the served transaction packet for the specified type. IE if a packet has the type 'custompacket', then you can define a method named _handle_custompacketgetPacketTransactionPacket object.Returns the transaction packet associated with this component.startTransactionThe TransactionService object handling this transaction.The packet for this transaction.Always returns true.Starts the transaction for the specified packet. Automatically invokes _handle_begin_transaction if defined.endTransactionThe TransactionService object handling this transaction.The packet for this transaction.Always returns true.Ends the transaction for the specified packet. Automatically invokes _handle_end_transaction if defined.doTransactionThe TransactionService object handling this transaction.The packet being served.Always returns false.Processes the served transaction packet. Automatically invokes _handle_transaction, if it was defined. Also will invoke _handle_packettype if defined. IE if a packet has the type 'custompacket', then you can define a method named _handle_custompacket (x || y); serveTransactionVariant value used to identify the type of the packet.Variant value used to identify the source of the packet.Bit indicating whether the packet should be served to the owner.Packet name.Returns true if a packet exists and was served, false otherwise.Serves the transaction packet to transaction participants. alert(n + ":" + p.participants.length); joinTranactionPacketThe packet name.The transaction packet identifier.Joins the object to the packet, and returns the packet identifier. alert("Warn packet overwrite: " + t.properties.PacketId + " with " + i); removeFromTransactionPacketThe packet name.The transaction packet identifier.Removes the object from the packet.serviceImplA class for managing communication between objects implementing the TransactionParticipant API, and using TransactionPacket objects.3.1.9isPacketName or index of the TransactionPacket object..Bit indicating whether the specified object name exists.Returns true if the specified name exists.getPacketsArray of TransactionPacket objects.Returns an array of TransactionPacket objects.getPacketIndex of the TransactionPacket object..XHTMLForm object.Returns the specified TransactionPacket object.getPacketByNameName of the element.TransactionPacket object.Returns the specified TransactionPacket object.sigtermSends a termination signal to the service, and closes all open packets.getRegisteredObjectsReturns an array of object identifiers that are registered with the TransactionService.Array of object identifiersgetRegisteredObjectsMapReturns a hashmap of object identifiers and the index into the registered objects array.Hashmap of object identifierscanRegisterObject to test whether or not it can be registered.Tests an object to determine if it can be registered.True if the object can be registered, otherwise false.isRegisteredObject to test whether or not it is registered.Returns whether an object is registered..True if the object is registered, otherwise false.registerObject to register with the TransactionService.Bit indicating the object should be instrumented with the transaction API.Registers an object with the transaction service.True if the object was registered, otherwise false.unregisterObject to register with the TransactionService.Unregisters an object with the transaction service.True if the object was unregistered, otherwise false.removeTransactionParticipantsObject that is registered with the TransactionService.Removes object from all transaction participations.addTransactionParticipantObject that is registered with the TransactionService.TransactionPacket with which the specified object should participate.Adds an object to participate with the specified TransactionPacket.True if the object is participating with the packet, otherwise false. HemiEngine.log("Add P: " + t.isRegistered(o) + " / " + t.isPacket(p) + " / " + p.participants[o.object_id]); removeTransactionParticipantObject that is registered with the TransactionService.TransactionPacket with which the specified object is participating.Removes an object from participating with the specified TransactionPacket.True if the object was removed from participating with the packet, otherwise false.serveTransactionTransactionPacket with which the specified object is participating.Identifier of the object that should act as the controller of the packet. Defaults to the packet owner.Skip serving the packet to the controller.Serves the specified TransactionPacket to its participants.True if the packet was served, otherwise false.closeTransactionName of the TransactionPacket.Closes the transaction represented by the specified TransactionPacket.newTransactionPacketPacket identifier.Packet name.Owner id.Variant data.Packet finalization handler.Creates a new TransactionPacket.A new TransactionPacket.openTransactionName of the transaction.Parent object.Data associated with the transaction.Function to invoke when transaction completes and the TransactionPacket is finalized.Opens a new transaction and returns the TransactionPacket identifier.Identifier of the new TransactionPacket.The Transaction Service provides an object-level communication bus. Unlike events, delegates, and message subscriptions and publications, the transaction service coordinates disimilar objects on a common band. Non Framework Objects may be decorated with the Transaction Participant API, and allow cross-Framework coordination.Hemi_api.htmlAPI Index