/usr/include/TelepathyLoggerQt/log-walker.h is in libtelepathy-logger-qt-dev 15.04.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | /*
* This file is part of TelepathyLoggerQt
*
* Copyright (C) 2013 Dan Vrátil <dvratil@redhat.com>
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _TelepathyLoggerQt_log_walker_h_HEADER_GUARD_
#define _TelepathyLoggerQt_log_walker_h_HEADER_GUARD_
#include "object.h"
#include "types.h"
#include <TelepathyLoggerQt_export.h>
namespace Tpl {
class PendingOperation;
class PendingEvents;
/*!
* \headerfile log-manager.h <TelepathyLoggerQt/LogWalker>
* \brief The LogWalker object allows the user to sequentially iterate over the logs.
*
* \since 0.8.0
*/
class TELEPATHY_LOGGER_QT_EXPORT LogWalker : public Tpl::Object
{
public:
/**
* \brief Whether the walker points to the most recent event in logs.
*
* Determines whether this walker is pointing at the most recent event in
* the logs. This is the case when it has not yet returned any
* events or has been rewound completely.
*
* \return Returns true if walker is pointing at the most recent event,
* otherwise false.
*/
bool isStart();
/**
* \brief Whether the walker has run out of events.
*
*
* Determines whether this walker has run out of events. This is the case
* when it has returned all the events from the logs.
*
* \return Returns true if walker has run out of events, otherwise false.
*/
bool isEnd();
/**
* \brief Retrieves \p numEvents of most recent events.
*
* Walks the logs to retrieve the next most recent \p numEvents events.
*
* \param numEvents Amount of events to retrieve
* \return Returns PendingOperation that will emit finished() when requested
* events are received or an error occurs.
*/
PendingEvents* queryEvents(uint numEvents);
/**
* \brief Moves the walker back by the last \p numEvents events.
*
* Move the walker back by the last \p numEvents events that were
* received by getEvents().
*
* \param numEvents Amount of events to rewind by
* \return Returns a PendingOperation that will emit finished() when
* walker has been rewound of an error occurs.
*/
PendingOperation* rewind(uint numEvents);
private:
QTELEPATHYLOGGERQT_WRAPPER(LogWalker)
};
} //Tpl
#endif
|