123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 |
- /*
- * Copyright 2005 - 2016 Zarafa and its licensors
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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 Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
- #ifndef IECCHANGEADVISOR_H
- #define IECCHANGEADVISOR_H
- #include "IECChangeAdviseSink.h"
- namespace KC {
- /**
- * IECChangeAdvisor: Interface for registering change notifications on folders.
- */
- class IECChangeAdvisor : public IUnknown{
- public:
- virtual HRESULT __stdcall GetLastError(HRESULT hResult, ULONG ulFlags, LPMAPIERROR *lppMAPIError) = 0;
- /**
- * Configure the change change advisor based on a stream.
- *
- * @param[in] lpStream
- * The stream containing the state of the state of the change advisor. This stream
- * is obtained by a call to UpdateState.
- * If lpStream is NULL, an empty state is assumed.
- * @param[in] lpGuid
- * Unused. Set to NULL.
- * @param[in] lpAdviseSink
- * The advise sink that will receive the change notifications.
- * @param[in] ulFlags
- * - SYNC_CATCHUP Update the internal state, but don't perform any operations
- * on the server.
- */
- virtual HRESULT __stdcall Config(LPSTREAM lpStream, LPGUID lpGUID, IECChangeAdviseSink *lpAdviseSink, ULONG ulFlags) = 0;
- /**
- * Store the current internal state in the stream pointed to by lpStream.
- *
- * @param[in] lpStream
- * The stream in which the current state will be stored.
- */
- virtual HRESULT __stdcall UpdateState(LPSTREAM lpStream) = 0;
- /**
- * Register one or more folders for change notifications through this change advisor.
- *
- * @param[in] lpEntryList
- * A list of keys specifying the folders to monitor. A key is an 8 byte
- * block of data. The first 4 bytes specify the sync id of the folder to
- * monitor. The second 4 bytes apecify the change id of the folder to monitor.
- * Use the SSyncState structure to easily create and access this data.
- */
- virtual HRESULT __stdcall AddKeys(LPENTRYLIST lpEntryList) = 0;
- /**
- * Unregister one or more folder for change notifications.
- *
- * @param[in] lpEntryList
- * A list of keys specifying the folders to monitor. See AddKeys for
- * information about the key format.
- */
- virtual HRESULT __stdcall RemoveKeys(LPENTRYLIST lpEntryList) = 0;
- /**
- * Check if the change advisor is monitoring the folder specified by a particular sync id.
- *
- * @param[in] ulSyncId
- * The sync id of the folder.
- * @return hrSuccess if the folder is being monitored.
- */
- virtual HRESULT __stdcall IsMonitoringSyncId(ULONG ulSyncId) = 0;
- /**
- * Update the changeid for a particular syncid.
- *
- * This is used to update the state of the changeadvisor. This is also vital information
- * when a reconnect is required.
- *
- * @param[in] ulSyncId
- * The syncid for which to update the changeid.
- * @param[in] ulChangeId
- * The new changeid for the specified syncid.
- */
- virtual HRESULT __stdcall UpdateSyncState(ULONG ulSyncId, ULONG ulChangeId) = 0;
- };
- } /* namespace */
- #endif
|