XMPPObjectStore class documentation

Authors

Generated by builder

Software documentation for the XMPPObjectStore class

XMPPObjectStore : ETXMLNullHandler

Declared in:
XMPPObjectStore.h
Conforms to:
ETSerialObjectStore
The XMPPObjectStore allows CoreObjects to be serialized via an XMPP connection.

Instance Variables

Method summary

beginObjectWithUUID: andApplication: 

- (void) beginObjectWithUUID: (ETUUID*)objUUID andApplication: (NSString*)registeredName;
Starts sending out the object on the stream, indicating its UUID and the name the handling application has registered with the DO nameservice. NOTE: After calling this method, the XMPPConversation cannot be used to send other data until the requesting process has finished serializing.

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 sending the data is finished by closing the "coreobject"- and "message"-tags of the store.

createBranch: from: 

- (void) createBranch: (NSString*)newBranch from: (NSString*)oldBranch;
Create a new branch from the specified parent branch.

dataForVersion: inBranch: 

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

initWithXMLParser: XMLWriter: parent: key: inConversation: 

- (id) initWithXMLParser: (ETXMLParser*)aParser XMLWriter: (ETXMLWriter*)aWriter parent: (id)aParent key: (id)aKey inConversation: (XMPPConversation*)aConversation;
Designated initializer to set up a fully fledge store.

initWithXMLWriter: inConversation: 

- (id) initWithXMLWriter: (ETXMLWriter*)aWriter inConversation: (XMPPConversation*)aConversation;
Initializer to be used if the store is used only for writing.

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) size;
Returns the amount of data written so far in this version. NOTE: Will always return 0.

startVersion: inBranch: 

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

version 

- (unsigned) 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)count;
Writes the specified data to the store.

xmlParser 

- (ETXMLParser*) xmlParser;
Returns the XML parser attached to the store.

xmlParserWillRead 

- (BOOL) xmlParserWillRead;
Returns whether the store's XML parser can be used to deserialize off the stream.

xmlWriter 

- (ETXMLWriter*) xmlWriter;
Returns the XML writer attached to the store.

xmlWriterWillStore 

- (BOOL) xmlWriterWillStore;
Returns whether the XML writer will store the XML itself so that the -writeBytes:count: method of the store does not need to be called.



Instance Variables for XMPPObjectStore Class

backendName

@protected NSString* backendName;
The name of the serialization backend used, if it can be derived.

branch

@protected NSString* branch;
The branch being serialized/deserialized.

buffer

@protected NSMutableData* buffer;
A buffer for data that might arrive in a non-XML format.

conversation

@protected id conversation;
The conversation the store is attached to. This needs to be tracked in order to finish the message that forms the root of the XML tree produced by the serializer.

deserializer

@protected id deserializer;
The deserializer handling the store.

proxy

@protected id proxy;
The remote process that is responsible for handling deserializations.

uuid

@protected ETUUID* uuid;
The UUID of the object in the store.

version

@protected NSUInteger version;
The version being serialized/deserialized

writer

@protected ETXMLWriter* writer;
The XML writer attached to the store.