Part of bzrlib.inter View In Hierarchy
Its instances have methods like join or copy_content or fetch, and contain references to the source and target objects these operations can be carried out between.
Often we will provide convenience methods on the objects which carry out operations with another of similar type - they will always forward to a subclass of InterObject - i.e. InterVersionedFile.get(other).method_name(parameters).
If the source and target objects implement the locking protocol - lock_read, lock_write, unlock, then the InterObject's lock_read, lock_write and unlock methods may be used (optionally in conjunction with the needs_read_lock and needs_write_lock decorators.)
When looking for an inter, the most recently registered types are tested first. So typically the most generic and slowest InterObjects should be registered first.
|Method||__init__||Construct a default InterObject instance. Please use 'get'.|
|Class Method||get||Retrieve a Inter worker object for these objects.|
|Method||lock_read||Take out a logical read lock.|
|Method||lock_write||Take out a logical write lock.|
|Class Method||register_optimiser||Register an InterObject optimiser.|
|Method||unlock||Release the locks on source and target.|
|Class Method||unregister_optimiser||Unregister an InterObject optimiser.|
|Method||_double_lock||Take out two locks, rolling back the first if the second throws.|
Only subclasses of InterObject should call InterObject.__init__ - clients should call InterFOO.get where FOO is the base type of the objects they are interacting between. I.e. InterVersionedFile or InterRepository. get() is a convenience class method which will create an optimised InterFOO if possible.
If an optimised worker exists it will be used otherwise a default Inter worker instance will be created.
|Parameters||source||the object to be the 'source' member of the InterObject instance.|
|target||the object to be the 'target' member of the InterObject instance.|
This will lock the source branch and the target branch. The source gets a read lock and the target a read lock.
This will lock the source branch and the target branch. The source gets a read lock and the target a write lock.