A pointer to persistent storage assigned to transient memory is valid only until the end of the outermost transaction in which the assignment occurred, unless objectstore::retain_persistent_addresses() is used. In addition, a pointer to storage in one database assigned to storage in another database is valid only until the end of the outermost transaction in which the assignment occurred, unless os_database::allow_external_pointers() or os_segment::allow_external_pointers() is used.
os_Reference_protecteds, in contrast, are always valid across transaction boundaries, as well as across databases.
Once the object referred to by an os_Reference_protected is deleted, use of the os_Reference_protected causes an err_reference_not_found exception to be signaled. If the referent database has been deleted, err_database_not_found is signaled.
The class os_Reference_protected is parameterized, with a parameter for indicating the type of the object referred to by a reference. This means that when specifying os_Reference_protected as a function's formal parameter, or as the type of a variable or data member, you must specify the parameter - the reference's referent type. You do this by appending to os_Reference_protected the name of the referent type enclosed in angle brackets (< >):
os_Reference_protected<referent-type-name>The referent type must be a class. For protected references to built-in types, such as int and char, see os_reference_protected.
The referent type parameter, T, occurs in the signatures of some of the functions described below. The parameter is used by the compiler to detect type errors.
part *a_part = ... ;
os_Reference_protected<part> part_ref = a_part;
When an os_Reference_protected<T*> is used where a T* is expected, os_Reference_protected::operator ->() or os_Reference_protected::operator T*() is implicitly invoked, returning a valid pointer to the object referred to by the os_Reference_protected.
printf("%d\n", part_ref->part_id);
Not all C++ operators have special reference class overloadings. References do not behave like pointers in the context of [] and ++, for example.In some cases involving multiple inheritance, comparing two references has a different result from comparing the corresponding pointers. For example, for == comparisons, if the referent type of one operand is a nonleftmost base class of the referent type of the other operand, the result is always 1. This is because comparing references never results in the pointer adjustment described in Section 10.3c of the C++ Annotated Reference Manual.
Each instance of this class stores a relative pathname to identify the referent database. The pathname is relative to the lowest common directory in the pathnames of the referent database and the database containing the reference. For example, if a reference stored in /A/B/C/db1 refers to data in /A/B/D/db2, the lowest common directory is A/B, so the relative pathname ../../Dfs/db2 is used.
This means that if you copy a database containing a reference, the reference in the copy and the reference in the original might refer to different databases. To change the database a reference refers to, you can use the ObjectStore utility oschangedbref. See ObjectStore Management.
The types os_int32 and os_boolean, used throughout this manual, are each defined as a signed 32-bit integer type. The type os_unsigned_int32 is defined as an unsigned 32-bit integer type.
All ObjectStore programs must include the header file <ostore/ostore.hh>.
os_boolean deleted() const;Returns 1 (true) if the object to which the specified reference refers has been deleted; returns 0 (false) otherwise.
char* dump(const char* db_str) const;Returns a heap-allocated string for the reference that the method was called. However, unlike the string returned by the char* os_Reference_protected::dump(void) method, the returned string does not contain an absolute database pathname. The returned string is intended to be used as the dump_str parameter of an os_Reference_protected load method of the form load(const char* dump_str, os_database* db). It is the responsibility of the caller of load to ensure that the db parameter passed to the load method is the same as the database of the dumped reference. It is the user's responsibility to delete the returned string when finished using the string.
This operation is useful in those applications in which you do not want the overhead of storing the absolute database path in the dumped strings.
void forget();Frees the memory in the underlying table used to associate the specified os_Reference_protected with its referent. Subsequent use of the os_Reference_protected will result in a run-time error.
os_database *get_database() const;Returns a pointer to the database containing the object referred to by the specified reference.
char* get_database_key(const char* dump_str);Returns a heap-allocated string containing the database_key component of the string dump_str. dump_str must have been generated using the dump operation. Otherwise, the exception err_reference_syntax is raised. It is the user's responsibility to delete the returned string when finished using the string.
os_database *get_open_database() const;Returns a pointer to the database containing the object referred to by the specified os_Reference_protected. Opens the database.
static os_typespec *get_os_typespec();Returns an os_typespec* for the class os_Reference_protected.
os_unsigned_int32 hash() const;Returns an integer suitable for use as a hash table key. The value returned is always the same for an os_Reference_protected to a given referent.
void load(const char* dump_str, const os_database* db);The dump_str parameter is assumed to be the result of a call to a compatible os_Reference dump method. It is the responsibility of the caller of load to ensure that the db parameter passed to the load method is the same as the database of the originally dumped reference. The loaded reference refers to the same object as the os_Reference used to dump the string as long as the db parameter is the same as the database of the dumped reference. The exception err_reference_syntax is raised if the dump_str is not in the expected format or if the dump_str was dumped from a nonprotected reference.
operator T*() const;Returns the T* for which the specified os_Reference_protected is a substitute. If the referent has been deleted, err_reference_not_found is signaled. If the referent database has been deleted, err_database_not_found is signaled.
T* operator ->() const;Returns the T* for which the specified os_Reference_protected is a substitute. If the referent has been deleted, err_reference_not_found is signaled. If the referent database has been deleted, err_database_not_found is signaled.
os_Reference_protected<T> &operator=(Establishes the referent of the right operand as the referent of the left operand.
const os_Reference_protected<T>&
);
os_Reference_protected<T> &operator=(const T*);Establishes the object pointed to by the right operand as the referent of the left operand.
os_boolean operator ==(os_Reference_protected const&) const;Returns 1 if the arguments have the same referent; returns 0 otherwise.
os_boolean operator !() const;Returns nonzero if the reference has no current referent.
os_boolean operator !=(os_Reference_protected const&) const;Returns 1 if the arguments have different referents; returns 0 otherwise.
os_boolean operator <(os_Reference_protected const&) const;If the first argument and second argument refer to elements of the same array or one beyond the end of the array, a return value of 1 indicates that the referent of the first argument precedes the referent of the second, and a return value of 0 indicates that it does not. Otherwise the results are undefined.
os_boolean operator >(os_Reference_protected const&) const;If the first argument and second argument refer to elements of the same array or one beyond the end of the array, a return value of 1 indicates that the referent of the first argument follows the referent of the second, and a return value of 0 indicates that it does not. Otherwise the results are undefined.
os_boolean operator >=(os_Reference_protected const&) const;If the first argument and second argument refer to elements of the same array or one beyond the end of the array, a return value of 1 indicates that the referent of the first argument follows or is the same as the referent of the second, and a return value of 0 indicates that it does not. Otherwise the results are undefined.
os_boolean operator <=(os_Reference_protected const&) const;If the first argument and second argument refer to elements of the same array or one beyond the end of the array, a return value of 1 indicates that the referent of the first argument precedes or is the same as the referent of the second, and a return value of 0 indicates that it does not. Otherwise the results are undefined.
os_Reference_protected(T*);Constructs an os_Reference_protected to substitute for the specified T*. If the T* points to transient memory, err_reference_to_transient is signaled. 0 is a legal argument.
T *resolve() const;Returns the valid T* for which the specified reference is a substitute. If the referent has been deleted, err_reference_not_found is signaled. If the referent database has been deleted, err_database_not_found is signaled.
Updated: 03/31/98 17:25:09