PreEmptive Analytics iOS API  2.0
The official iOS API for sending PreEmptive Analytics data.
PAFlowController.h
1 //
2 // PAFlowController.h
3 // PreEmptiveAnalyticsClient
4 //
5 // Copyright (c) 2013 PreEmptive Solutions. All rights reserved.
6 //
7 
8 
9 
14 
18 @property NSUInteger queueSize;
19 
23 @property NSUInteger highWater;
24 
28 @property NSUInteger minimumInterval;
29 
33 @property NSUInteger maximumInterval;
34 
38 @property BOOL offline;
39 
44 @property BOOL sendDisabled;
45 
49 @property BOOL supportOfflineStorage;
50 
54 @property NSUInteger maximumBatchSize;
55 
59 @property NSUInteger minimumFailureCount;
60 
64 @property NSUInteger minimumTimeToLive;
65 
71 -(NSUInteger) getInterval:(NSUInteger)numberOfMessages;
72 
78 -(NSUInteger) messagesToDrop:(NSUInteger)currentMessageCount;
79 
84 -(BOOL) okToTransmit;
85 
90 -(void) onSend:(BOOL)sendSucceeded;
91 
92 
99 -(BOOL) hasBatchExpired:(NSDate*)date attempts:(NSUInteger) attempts;
100 
101 @end
NSUInteger queueSize
The maximum number of messages that can be held in the queue.
NSUInteger maximumBatchSize
The maximum size (in bytes) of a message batch.
NSUInteger minimumTimeToLive
The minimum age(in seconds) a message must be before it becomes eligible for deletion from offline st...
BOOL okToTransmit()
Determines if message sending is currently permitted.
BOOL sendDisabled
Is the transmission of messages temporarily disabled?
BOOL supportOfflineStorage
Is offline storage of messages permitted?
BOOL offline
Is the transmission of messages prohibited?
NSUInteger minimumFailureCount
The minimum amount of times a message should be attempted to be sent before becoming eligible for del...
NSUInteger maximumInterval
The maximum amout of time the transmitter should wait between checking the message queue specified in...
NSUInteger minimumInterval
The minimum amout of time the transmitter should wait between checking the message queue specified in...
Protocol for defining a flow controller.
NSUInteger highWater
The point at which queued messages should be batched and sent.