ETObjectStore documentation

Authors

Generated by builder

Contents -

  1. Software documentation for the ETSerialObjectBuffer class
  2. Software documentation for the ETSerialObjectBundle class
  3. Software documentation for the ETSerialObjectSocket class
  4. Software documentation for the ETSerialObjectStdout class
  5. Software documentation for the ETSeekableObjectStore protocol
  6. Software documentation for the ETSerialObjectStore protocol

Software documentation for the ETSerialObjectBuffer class

ETSerialObjectBuffer : NSObject

Declared in:
ETObjectStore.h
Conforms to:
ETSeekableObjectStore
Object 'store' which keeps the data written to it in memory. Doesn't support commit and branching operations.

Instance Variables

Method summary

buffer 

- (NSData*) buffer;
Returns the buffer for the current version.



Instance Variables for ETSerialObjectBuffer Class

branch

@protected NSString* branch;
Description forthcoming.

buffer

@protected NSMutableData* buffer;
Description forthcoming.

version

@protected unsigned int version;
Description forthcoming.




Software documentation for the ETSerialObjectBundle class

ETSerialObjectBundle : NSObject

Declared in:
ETObjectStore.h
Conforms to:
ETSeekableObjectStore
Description forthcoming.

Instance Variables

Method summary

initWithPath: 

- (id) initWithPath: (NSString*)aPath;
This is a designated initialiser for the class.
Description forthcoming.

setPath: 

- (void) setPath: (NSString*)aPath;
Description forthcoming.



Instance Variables for ETSerialObjectBundle Class

branch

@protected NSString* branch;
Description forthcoming.

bundlePath

@protected NSString* bundlePath;
Description forthcoming.

file

@protected FILE* file;
Description forthcoming.

version

@protected unsigned int version;
Description forthcoming.




Software documentation for the ETSerialObjectSocket class

ETSerialObjectSocket : ETSerialObjectBuffer

Declared in:
ETObjectStore.h
Object 'store' which sends data over the network to the specified host. Supports commit but not branching operations.

Instance Variables

Method summary

initWithRemoteHost: forService: 

- (id) initWithRemoteHost: (NSString*)aHost forService: (NSString*)aService;
This is a designated initialiser for the class.
Initializes the store pointing to the specified host and network service. Defaults to using the CoreObject service (which must exist in /etc/services in order to work).



Instance Variables for ETSerialObjectSocket Class

socket

@protected ETSocket* socket;
The socket




Software documentation for the ETSerialObjectStdout class

ETSerialObjectStdout : ETSerialObjectBuffer

Declared in:
ETObjectStore.h
Object 'store' which simply logs the serialiser output to stdout. Useful for debugging.
Supports commit but not branching operations.

Software documentation for the ETSeekableObjectStore protocol

ETSeekableObjectStore

Declared in:
ETObjectStore.h
Conforms to:
ETSerialObjectStore
Description forthcoming.
Method summary

replaceRange: withBytes: 

- (void) replaceRange: (NSRange)aRange withBytes: (unsigned char*)bytes;
Replaces the bytes in the specified range with (the same number of) new bytes.

Software documentation for the ETSerialObjectStore protocol

ETSerialObjectStore

Declared in:
ETObjectStore.h
Conforms to:
NSObject
Description forthcoming.
Method summary

branch 

- (NSString*) branch;
Returns the branch currently being written, or the last branch to be written if the version is finalised.

commit 

- (void) commit;
Guarantees that the data is committed to the backing store.

createBranch: from: 

- (void) createBranch: (NSString*)newBranch from: (NSString*)oldBranch;
Creates a new branch from the specified parent branch. Doesn't change the current branch.

dataForVersion: inBranch: 

- (NSData*) dataForVersion: (unsigned int)aVersion inBranch: (NSString*)aBranch;
Interface for an object store that allows serial data to be written to it.

isValidBranch: 

- (BOOL) isValidBranch: (NSString*)aBranch;
Returns true if the specified branch exists.

parentOfBranch: 

- (NSString*) parentOfBranch: (NSString*)aBranch;
Returns the branch that is the parent of the specified branch.

size 

- (unsigned int) size;
Returns the amount of data written so far in this version.

startVersion: inBranch: 

- (void) startVersion: (unsigned int)aVersion inBranch: (NSString*)aBranch;
Start a new version in the specified branch. Subsequent data will be written to this branch.

version 

- (NSUInteger) version;
Returns the version currently being written, or the last version to be written if the version is finalised.

writeBytes: count: 

- (void) writeBytes: (unsigned char*)bytes count: (unsigned int)count;
Writes the specified data to the store.