diff options
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h')
| -rw-r--r-- | SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h index b3f100e1e..90a7ddc15 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLPrioritizedObjectCollection.h @@ -7,7 +7,21 @@ @interface SDLPrioritizedObjectCollection : NSObject +/** + * Add a new object to a push-pop collection. The object will be added in a location based on the priority passed in. + * + * A lower priority number is considered to be "higher". This is because this class is generally used with RPC service numbers, and lower services preempt higher ones. + * + * @param object The object to be added to the priority collection + * @param priority The priority to use when determining the location of the object in the collection. A lower number is considered a higher priority + */ - (void)addObject:(id)object withPriority:(NSInteger)priority; + +/** + * Retreive the highest priority object from the collection. This also removes the object. + * + * @return The highest priority object retrieved from the collection. + */ - (id)nextObject; @end |