perst.xml

Perst开源实时数据库

        <member name="P:Perst.FieldIndex.IndexedClass">
            <summary>
            Get class obejct objects which can be inserted in this index
            </summary>
            <returns>class specified in Storage.createFielIndex method</returns>
        </member>
        <member name="P:Perst.FieldIndex.KeyField">
            <summary>
            Get key field
            </summary>
            <returns>field info for key field</returns>
        </member>
        <member name="T:Perst.MultiFieldIndex">
            <summary> Interface of multifield index. 
            </summary>
        </member>
        <member name="P:Perst.MultiFieldIndex.KeyFields">
            <summary>
            Get fields used as a key
            </summary>
            <returns>array of index key fields</returns>
        </member>
        <member name="T:Perst.ISet">
            <summary>
             Interface of objects set
             </summary>
        </member>
        <member name="M:Perst.ISet.Contains(Perst.IPersistent)">
            <summary>
            Check if set contains specified element
            </summary>
            <param name="o">checked element</param>
            <returns><code>true</code> if elementis in set</returns>
        </member>
        <member name="M:Perst.ISet.ContainsAll(System.Collections.ICollection)">
            <summary>
            Check if the set contains all members from specified collection
            </summary>
            <param name="c">collection specifying members</param>
            <returns><code>true</code> if all members of enumerator are present in the set</returns>
        </member>
        <member name="M:Perst.ISet.Add(Perst.IPersistent)">
            <summary>
            Add new element to the set
            </summary>
            <param name="o">element to be added</param>
        </member>
        <member name="M:Perst.ISet.AddAll(System.Collections.ICollection)">
            <summary>
            Add all elements from specified collection to the set
            </summary>
            <param name="c">collection specifying members</param>
            <returns><code>true</code> if at least one element was added to the set,
            <code>false</code> if now new elements were added</returns>
        </member>
        <member name="M:Perst.ISet.Remove(Perst.IPersistent)">
            <summary> 
            Remove element from the set
            </summary>
            <param name="o">removed element</param>
            <returns><code>true</code> if element was successfully removed,
            <code>false</code> if there is not such element in the set</returns>
        </member>
        <member name="M:Perst.ISet.RemoveAll(System.Collections.ICollection)">
            <summary>
            Remove from the set all members from the specified enumerator
            </summary>
            <param name="c">collection specifying members</param>
            <returns></returns>
        </member>
        <member name="M:Perst.ISet.ToArray">
            <summary>
            Copy all set members to an array
            </summary>
            <returns>array of object with set members</returns>
        </member>
        <member name="M:Perst.ISet.ToArray(System.Type)">
            <summary>
            Copy all set members to an array of specified type
            </summary>
            <param name="elemType">type of array element</param>
            <returns>array of specified type with members of the set</returns>
        </member>
        <member name="M:Perst.ISet.Clear">
            <summary>
            Remove all set members
            </summary>
        </member>
        <member name="T:Perst.Impl.AsyncReplicationMasterFile">
            <summary>
            File performing asynchronous replication of changed pages to specified slave nodes.
            </summary>
        </member>
        <member name="T:Perst.Impl.ReplicationMasterFile">
            <summary>
            File performing replication of changed pages to specified slave nodes.
            </summary>
        </member>
        <member name="T:Perst.IFile">
            <summary> Interface of file.
            Prorgemmer can provide its own impleentation of this interface, adding such features
            as support of flash cards, encrypted files,...
            Implentation of this interface should throw StorageError exception in case of failure
            </summary>
        </member>
        <member name="M:Perst.IFile.Write(System.Int64,System.Byte[])">
            <summary> Write data to the file
            </summary>
            <param name="pos"> offset in the file
            </param>
            <param name="buf"> array with data to be writter (size is always equal to database page size)
            </param>
            
        </member>
        <member name="M:Perst.IFile.Read(System.Int64,System.Byte[])">
            <summary> Reade data from the file
            </summary>
            <param name="pos"> offset in the file
            </param>
            <param name="buf"> array to receive readen data (size is always equal to database page size)
            </param>
            <returns> param number of bytes actually readen
            </returns>
        </member>
        <member name="M:Perst.IFile.Sync">
            <summary> Flush all fiels changes to the disk
            </summary>
        </member>
        <member name="M:Perst.IFile.Lock">
            <summary>
            Prevent other processes from modifying the file
            </summary>
        </member>
        <member name="M:Perst.IFile.Close">
            <summary> Close file
            </summary>
        </member>
        <member name="P:Perst.IFile.NoFlush">
            <summary>
            Boolean property. Set to <c>true</c> to avoid flushing the stream, or <c>false</c> to flush the stream with every calls to <see cref="M:Perst.IFile.Sync"/>
            </summary>
        </member>
        <member name="P:Perst.IFile.Length">
            <summary>
            Length of the file
            </summary>
            <returns>length of file in bytes</returns>
        </member>
        <member name="M:Perst.Impl.ReplicationMasterFile.#ctor(Perst.Impl.ReplicationMasterStorageImpl,Perst.IFile)">
            <summary>
            Constructor of replication master file
            </summary>
            <param name="storage">replication storage</param>
            <param name="file">local file used to store data locally</param>
        </member>
        <member name="M:Perst.Impl.ReplicationMasterFile.#ctor(Perst.IFile,System.String[],System.Boolean)">
            <summary>
            Constructor of replication master file
            </summary>
            <param name="file">local file used to store data locally</param>
            <param name="hosts">slave node hosts to which replicastion will be performed</param>
            <param name="ack">whether master should wait acknowledgment from slave node during trasanction commit</param>
        </member>
        <member name="M:Perst.Impl.ReplicationMasterFile.HandleError(System.String)">
            <summary>
            When overriden by base class this method perfroms socket error handling
            </summary>     
            <returns><code>true</code> if host should be reconnected and attempt to send data to it should be 
            repeated, <code>false</code> if no more attmpts to communicate with this host should be performed 
            </returns>
        </member>
        <member name="M:Perst.Impl.AsyncReplicationMasterFile.#ctor(Perst.Impl.ReplicationMasterStorageImpl,Perst.IFile,System.Int32)">
            <summary>
            Constructor of replication master file
            <param name="storage">replication storage</param>
            <param name="file">local file used to store data locally</param>
            <param name="asyncBufSize">size of asynchronous buffer</param>
            </summary>
        </member>
        <member name="M:Perst.Impl.AsyncReplicationMasterFile.#ctor(Perst.IFile,System.String[],System.Int32,System.Boolean)">
            <summary>
            Constructor of replication master file
            <param name="file">local file used to store data locally</param>
            <param name="hosts">slave node hosts to which replicastion will be performed</param>
            <param name="asyncBufSize">size of asynchronous buffer</param>
            <param name="ack">whether master should wait acknowledgment from slave node during trasanction commit</param>
            </summary>
        </member>
        <member name="T:Perst.BitIndex">
            <summary>
            Interface of bit index.
            Bit index allows to effiicently search object with specified 
            set of properties. Each object has associated mask of 32 bites. 
            Meaning of bits is application dependent. Usually each bit stands for
            some binary or boolean property, for example "sex", but it is possible to 
            use group of bits to represent enumerations with more possible values.
            </summary>
        </member>
        <member name="M:Perst.BitIndex.Get(Perst.IPersistent)">
            <summary>
            Get properties of specified object
            </summary>
            <param name="obj">object which properties are requested</param>
            <returns>bit mask associated with this objects</returns>
            <exception cref="T:Perst.StorageError">StorageError(StorageError.ErrorCode.KEY_NOT_FOUND) exception if there is no such object in the index
            </exception>
        </member>
        <member name="M:Perst.BitIndex.Put(Perst.IPersistent,System.Int32)">
            <summary>
            Put new object in the index. If such objct already exists in index, then its
            mask will be rewritten 
            </summary>
            <param name="obj">object to be placed in the index. Object can be not yet peristent, in this case
            its forced to become persistent by assigning OID to it.
            </param>
            <param name="mask">bit mask associated with this objects</param>
        </member>
        <member name="M:Perst.BitIndex.Remove(Perst.IPersistent)">
            <summary>
            Remove object from the index 
            </summary>
            <param name="obj">object removed from the index
            </param>
            <returns><code>true</code> if member was successfully removed or <code>false</code> if member is not found</returns>
        </member>
        <member name="M:Perst.BitIndex.Size">
            <summary> Get number of objects in the index
            </summary>
            <returns>number of objects in the index
            
            </returns>
        </member>
        <member name="M:Perst.BitIndex.Clear">
            <summary> Remove all objects from the index
            </summary>
        </member>
        <member name="M:Perst.BitIndex.GetEnumerator(System.Int32,System.Int32)">
            <summary>
            Get enumerator for selecting objects with specified properties.
            </summary>
            <param name="setBits">bitmask specifying bits which should be set (1)</param>
            <param name="clearBits">bitmask specifying bits which should be cleared (0)</param>
            <returns>enumerator</returns>
        </member>
        <member name="M:Perst.BitIndex.Select(System.Int32,System.Int32)">
            <summary>
            Get enumerable collection for selecting objects with specified properties.
            </summary>