abs.ixi.client.io

Interface UndeliveredStanzaManager.PersistenceMechanism

All Known Implementing Classes:

DefaultPersistenceMechanism

Enclosing class:

UndeliveredStanzaManager

public static interface UndeliveredStanzaManager.PersistenceMechanism

An injectable interface which allows applications to define custom mechanism to persist undelivered stanzas. When SDK is loaded in the memory, at any given point there may be stanza packets in the memory waiting for ACK from server. Until the ACK is received from server, these stanza packets are considered undelivered.

If the SDK is off-loaded from memory for some reason (typically after shutdown), it is important that all the in-flight packets are persisted to some store (file system, database etc). UndeliveredStanzaManager uses UndeliveredStanzaManager.PersistenceMechanism (which will typically be injected by the application) to persist in-flight packets. These packets will be read when SDK is loaded again into the memory and will be sent to XMPPPacketWriter to send them to server.

Author:

Yogi

Method Summary

Modifier and Type	Method and Description
List<Stanza>	readAll() Read all the stanzas from persistent store and delete them.
void	remove(int stanzaCount) Remove number of stanza from persistent store.
void	truncateUndeliverStanzas() Delete All stanzas from store.
void	write(List<Stanza> stanzas) Write a stanza to persistent store.
void	write(Stanza stanza) Write a stanza to persistent store.

Method Detail

write

void write(Stanza stanza)
    throws IOException

Write a stanza to persistent store. It is recommended that stanza packets are serialized before writting them to the persistent store.

Parameters:

stanza - stanza

Throws:

IOException - IOException

write

void write(List<Stanza> stanzas)
    throws IOException

Write a stanza to persistent store. It is recommended that stanza packets are serialized before writting them to the persistent store.

Parameters:

stanzas - stanzas

Throws:

IOException - IOException

remove

void remove(int stanzaCount)
     throws IOException

Remove number of stanza from persistent store.

Parameters:

stanzaCount - stanzaCount

Throws:

IOException - IOException

readAll

List<Stanza> readAll()
              throws IOException

Read all the stanzas from persistent store and delete them.

Returns:

List list

Throws:

IOException - IOException

truncateUndeliverStanzas

void truncateUndeliverStanzas()

Delete All stanzas from store.