Files

Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation

This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15

2014-06-17 14:07:42 -04:00

1.9 KiB

Raw Blame History

vim.event.EventHistoryCollector

EventHistoryCollector provides a mechanism for retrieving historical data and updates when the server appends new events.

extends: vim.HistoryCollector

Attributes

latestPage (vim.event.Event):

The items in the 'viewable latest page'. As new events that match the collector's EventFilterSpec are created, they are added to this page, and the oldest events are removed from the collector to keep the size of the page to that allowed by HistoryCollector#setLatestPageSize.The "oldest event" is the one with the smallest key (event ID). The events in the returned page are unordered.

Methods

ReadNextEvents(maxCount):

Reads the 'scrollable view' from the current position. The scrollable position is moved to the next newer page after the read. No item is returned when the end of the collector is reached.

Privilege:

Args:

maxCount (int):: The maximum number of items in the page.

Returns:

vim.event.Event:

Raises:

vmodl.fault.InvalidArgument:

if maxCount is out of range.

ReadPreviousEvents(maxCount):

Reads the 'scrollable view' from the current position. The scrollable position is moved to the next older page after the read. No item is returned when the head of the collector is reached.