| Left: | ||
| Right: |
| LEFT | RIGHT |
|---|---|
| 1 /* | 1 /* |
| 2 * This file is part of Adblock Plus <https://adblockplus.org/>, | 2 * This file is part of Adblock Plus <https://adblockplus.org/>, |
| 3 * Copyright (C) 2006-present eyeo GmbH | 3 * Copyright (C) 2006-present eyeo GmbH |
| 4 * | 4 * |
| 5 * Adblock Plus is free software: you can redistribute it and/or modify | 5 * Adblock Plus is free software: you can redistribute it and/or modify |
| 6 * it under the terms of the GNU General Public License version 3 as | 6 * it under the terms of the GNU General Public License version 3 as |
| 7 * published by the Free Software Foundation. | 7 * published by the Free Software Foundation. |
| 8 * | 8 * |
| 9 * Adblock Plus is distributed in the hope that it will be useful, | 9 * Adblock Plus is distributed in the hope that it will be useful, |
| 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
| 13 * | 13 * |
| 14 * You should have received a copy of the GNU General Public License | 14 * You should have received a copy of the GNU General Public License |
| 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. | 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
| 16 */ | 16 */ |
| 17 | 17 |
| 18 package org.adblockplus.libadblockplus.android; | 18 package org.adblockplus.libadblockplus.android; |
| 19 | 19 |
| 20 public interface AdblockEngineProvider | 20 public interface AdblockEngineProvider |
| 21 { | 21 { |
| 22 /** | 22 /** |
| 23 * Register AdblockEngine client | 23 * Register AdblockEngine client |
| 24 * @param asynchronous If `true` engines will be created in background thread without locking of | 24 * @param asynchronous If `true` engines will be created in background thread without locking of |
| 25 * current thread. Use waitForReady() before getEngine() l ater. | 25 * current thread. Use waitForReady() before getEngine() l ater. |
| 26 * If `false` locks current thread. | 26 * If `false` locks current thread. |
| 27 * @return if a new instance is allocated | 27 * @return if a new instance is allocated |
|
sergei
2018/01/19 13:56:41
Is it actually required to know that a new instanc
anton
2018/01/22 06:17:37
Yes, in AdblockChromium we need to know it to send
| |
| 28 */ | 28 */ |
| 29 boolean retain(boolean asynchronous); | 29 boolean retain(boolean asynchronous); |
| 30 | 30 |
| 31 /** | 31 /** |
| 32 * Wait until everything is ready (used for `retain(true)`) | 32 * Wait until everything is ready (used for `retain(true)`) |
| 33 * Warning: locks current thread | 33 * Warning: locks current thread |
| 34 */ | 34 */ |
| 35 void waitForReady(); | 35 void waitForReady(); |
| 36 | 36 |
| 37 /** | 37 /** |
| 38 * Return AdblockEngine instance | 38 * Return AdblockEngine instance |
| 39 * @return AdblockEngine instance. Can be `null` is not yet retained or alread y released | 39 * @return AdblockEngine instance. Can be `null` if not yet retained or alread y released |
|
sergei
2018/01/19 13:56:41
Typo in "Can be `null` is not yet retained"
anton
2018/01/22 06:17:37
Acknowledged.
| |
| 40 */ | 40 */ |
| 41 AdblockEngine getEngine(); | 41 AdblockEngine getEngine(); |
| 42 | 42 |
| 43 /** | 43 /** |
| 44 * Unregister AdblockEngine client | 44 * Unregister AdblockEngine client |
| 45 * @return `true` if the last instance is destroyed | 45 * @return `true` if the last instance is destroyed |
| 46 */ | 46 */ |
| 47 boolean release(); | 47 boolean release(); |
| 48 | 48 |
| 49 /** | 49 /** |
| 50 * Get registered clients count | 50 * Get registered clients count |
| 51 * @return registered clients count | 51 * @return registered clients count |
| 52 */ | 52 */ |
| 53 int getCounter(); | 53 int getCounter(); |
| 54 } | 54 } |
| LEFT | RIGHT |