ScaleOut C++ Native Client API  5.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Pages
sosscli::ObjectMetadata Class Reference

The ObjectMetadata class contains extended (read-only) object information from the SOSS store for a given object. More...

#include <object_metadata.h>

Public Types

enum  BackingStoreMode { ASYNC_WRITE_BEHIND, ASYNC_REFRESH_AHEAD, ASYNC_WRITE_AND_REFRESH }
 Enumeration specifying the type of backing store policy associated with the object.
 
enum  CoherencyPolicy { NONE, POLL, NOTIFY }
 Enumeration specifying the coherency policy associated with the object.
 
enum  ReplicationStatus { SUCCESS, UPDATE_FAILED, REFRESH_FAILED }
 Enumeration specifying the replication status of the object.
 

Public Member Functions

 ObjectMetadata (PSOSS_OBJ_METADATA pobj_metadata)
 Constructor which accepts a pointer to a low-level C struct for conversion to a C++ object.
 
virtual ~ObjectMetadata (void)
 Destructor.
 
ObjectPolicy object_policy () const
 Gets object's policy, which contains information like object timeout and parent relationships.
 
unsigned long size () const
 Gets object's size in bytes.
 
BackingStoreMode backstore_mode () const
 Gets backing store operations for this object.
 
bool immutable () const
 Gets whether object may be changed once updated.
 
boost::posix_time::time_duration backstore_timeout () const
 Gets backing store timeout.
 
boost::posix_time::time_duration coherency_timeout () const
 Gets timeout before making a coherency check.
 
CoherencyPolicy coherency_policy () const
 Gets coherency policy for this object.
 
ReplicationStatus last_replication_succeeded () const
 Gets status of the last replication operation.
 
bool is_proxy () const
 Gets whether this is a normal or proxy (read only) object.
 
bool allow_remote () const
 Gets whether this object may be accessed by a remote store.
 

Detailed Description

The ObjectMetadata class contains extended (read-only) object information from the SOSS store for a given object.

This class allows you to retrieve the StateServer ObjectPolicy, size, backing store mode and timeout, whether the object is immutable to further changes, coherency policy and timeout, whether the last replication succeeded, whether this is a proxy object, and whether this object allows remote GeoServer access.


The documentation for this class was generated from the following file: