Member Functions

virtual Sint32 mi::​bridge::​IServer_transaction::add_transaction_callback( IServer_transaction_callback* callback) [pure virtual]

Adds a transaction callback. The callback will be called when the transaction has been committed or aborted by the client, or if there is an error causing the transaction to be aborted.

See also:

remove_transaction_callback()

Parameters

callback

The callback to be added.

Returns

• 0: Success.
• -1: Invalid argument (callback is NULL).
• -2: The transaction is not open.
• -3: The transaction callback was already added.
• <= -4: Unspecified error.

virtual Sint32 mi::​bridge::​IServer_transaction::create_incremental_snapshot_context( const char* element, IString* snapshot_id, IIncremental_snapshot_context** context) [pure virtual]

Creates a base snapshot and a context for subsequent incremental snapshots. In contrast to regular snapshots, incremental snapshots contain only those elements that have been changed since the last incremental snapshot of the same context. The first incremental snapshot, also called base snapshot, of a given context contains all elements, just as the regular snapshot.

Incremental snapshots must be imported in the same order as they were created, starting with the base snapshot.

Note:

The current transaction is only used for the base snapshot, the context itself is not bound to this transaction.

See also:

create_snapshot(), mi::bridge::IBridge_server::create_snapshot_context()

Parameters

element

The top level element that incremental snapshots will be created for.

snapshot_id

The ID of the snapshot will be stored here if the operation is successful.

context

The context to be used for incremental snapshots.

Returns

• 0: Success.
• -1: Invalid parameters (element, snapshot_id, or context is NULL).
• -2: The specified element does not exist.
• -3: Failed to create the snapshot.
• <= -4: Unspecified error.

virtual Sint32 mi::​bridge::​IServer_transaction::create_snapshot( const char* element, IString* snapshot_id) [pure virtual]

Creates a snapshot of some database elements. The snapshot will save the provided element and all elements it references in their current state into the disk cache. The snapshot will only reference data already in the disk cache so storage cost of snapshots is very low. Data in the disk cache is guaranteed not to be removed for as long as there exists at least one snapshot that references the data.

See also:

create_incremental_snapshot_context(), mi::bridge::IBridge_server::create_snapshot_context()

Parameters

element

The top level element to save the snapshot for.

snapshot_id

The ID of the snapshot will be stored here if the operation is successful.

Returns

• 0: Success.
• -1: Invalid arguments (element or snapshot_id is NULL).
• -2: The specified element does not exist.
• -3: Failed to create the snapshot.
• <= -4: Unspecified error.

virtual neuraylib::​ITransaction* mi::​bridge::​IServer_transaction::get_database_transaction() const [pure virtual]

Returns the local transaction corresponding to this Bridge transaction, or NULL if this transaction has not yet been started on the client. The IServer_transaction instance passed to mi::bridge::IServer_job::execute() will always be started. IServer_transaction instances returned by mi::bridge::IServer_session::get_pending_transactions() are however not always started yet, in which case this method will return NULL.

Returns

the database transaction or NULL if this bridge transaction has not yet been started.

template< class T>

T* mi::​bridge::​IServer_transaction::get_database_transaction() const [inline]

Returns the local transaction corresponding to this Bridge transaction. This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

virtual const char* mi::​bridge::​IServer_transaction::get_id() const [pure virtual]

Returns the id of this Bridge transaction. The id is only guaranteed to be unique among the currently active transactions and is suitable only for log messages and the like. Note that the Bridge transaction id is not the same as the id of the database transaction returned by get_database_transaction().

virtual IServer_job_list* mi::​bridge::​IServer_transaction::get_pending_jobs() const [pure virtual]

Returns the list of currently pending jobs for this transaction in the order they will be executed. Note that jobs added after the call to this method won't be present in the list and that jobs might have completed execution when this list is processed. Also note that jobs within this transaction will execute in sequence but jobs belonging to other transactions might execute in parallel if the transactions execute in parallel.

Two transactions will execute in sequence if the second transaction is started after the previous transaction was committed. Example: start A, commit A, start B commit B. They will execute in parallel if the second transaction is started before the previous transaction is committed. For instance start A, start B, commit A, commit B.

Returns

A list of pending jobs in the order they will be executed.

virtual IServer_session* mi::​bridge::​IServer_transaction::get_session() const [pure virtual]

Returns the session of the transaction.

virtual Size mi::​bridge::​IServer_transaction::get_updated_element_count() const [pure virtual]

Returns the number of database elements updated by this transaction so far. This number includes elements that have just been uploaded to the disk cache as well as elements that also have been replicated in the database.

virtual Sint32 mi::​bridge::​IServer_transaction::remove_transaction_callback( IServer_transaction_callback* callback) [pure virtual]

Removes a transaction callback.

See also:

add_transaction_callback()

Parameters

callback

The callback to be removed.

Returns

• 0: Success.
• -1: Invalid argument (callback is NULL).
• -2: There is no such callback.
• <= -3: Unspecified error.