neuray API Programmer's Manual

mi::bridge::IClient_scope Class Reference

[Bridge client]

Description

Represents the client side of a Bridge scope. All data synchronization and job execution on the server requires a pair of client-side and server-side Bridge scopes. The lifetime of the server-side scope is bound to the lifetime client-side scope.

A Bridge scope can be used to create Bridge transactions.

See also:

mi::bridge::IClient_session::get_scope()

mi::base::Interface_declare\< 0xfff9d40, 0xaa9e, 0x4974, 0xb4, 0xcd, 0x85, 0xb9, 0x8b, 0x50, 0x8b, 0xeb \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual IClient_transaction* create_transaction( neuraylib::​ITransaction* transaction) =0
Creates a Bridge transaction that wraps the provided regular transaction. More...

Member Functions

virtual IClient_transaction* mi::​bridge::​IClient_scope::create_transaction( neuraylib::​ITransaction* transaction) [pure virtual]

Creates a Bridge transaction that wraps the provided regular transaction. If no transaction is provided one will be created automatically. If a transaction is provided it must be in the same scope as the regular scope wrapped by this Bridge scope.

Note:

"Mirroring" does not imply that all DB changes in the transaction are automatically replicated on the server. It is up to the executed jobs to indicate which DB elements need to be replicated. A Bridge transaction (and Bridge scope) just establishes the context for that.

Parameters

transaction
The regular transaction to wrap, or NULL to create a new transaction.

Returns

A Bridge transaction wrapping transaction , or NULL in case of failures.