Rename AnnouncementObserver to AnnouncementListener.
I feel this wording match java naming more closely.
Bug: 68045105
Test: VTS
Change-Id: If30fa9b356b6b45fe8853bc5194c7098d0fb2aa5
diff --git a/broadcastradio/2.0/Android.bp b/broadcastradio/2.0/Android.bp
index 7409005..2434fdc 100644
--- a/broadcastradio/2.0/Android.bp
+++ b/broadcastradio/2.0/Android.bp
@@ -8,7 +8,7 @@
},
srcs: [
"types.hal",
- "IAnnouncementObserver.hal",
+ "IAnnouncementListener.hal",
"IBroadcastRadio.hal",
"ICloseHandle.hal",
"ITunerCallback.hal",
diff --git a/broadcastradio/2.0/IAnnouncementObserver.hal b/broadcastradio/2.0/IAnnouncementListener.hal
similarity index 85%
rename from broadcastradio/2.0/IAnnouncementObserver.hal
rename to broadcastradio/2.0/IAnnouncementListener.hal
index c91e29a..1b4960c 100644
--- a/broadcastradio/2.0/IAnnouncementObserver.hal
+++ b/broadcastradio/2.0/IAnnouncementListener.hal
@@ -16,11 +16,11 @@
package [email protected];
/**
- * Callback interface for announcement observer.
+ * Callback interface for announcement listener.
*
- * For typical configuration, the observer is a broadcast radio service.
+ * For typical configuration, the listener is a broadcast radio service.
*/
-interface IAnnouncementObserver {
+interface IAnnouncementListener {
/**
* Called whenever announcement list has changed.
*
diff --git a/broadcastradio/2.0/IBroadcastRadio.hal b/broadcastradio/2.0/IBroadcastRadio.hal
index 7578f44..bedc362 100644
--- a/broadcastradio/2.0/IBroadcastRadio.hal
+++ b/broadcastradio/2.0/IBroadcastRadio.hal
@@ -15,7 +15,7 @@
package [email protected];
-import IAnnouncementObserver;
+import IAnnouncementListener;
import ICloseHandle;
import ITunerCallback;
import ITunerSession;
@@ -104,7 +104,7 @@
getImage(uint32_t id) generates (vec<uint8_t> image);
/**
- * Registers announcement observer.
+ * Registers announcement listener.
*
* If there is at least one observer registered, HAL implementation must
* notify about announcements even if no sessions are active.
@@ -113,15 +113,15 @@
* automatically.
*
* @param enabled The list of announcement types to watch for.
- * @param cb The callback interface.
+ * @param listener The listener interface.
* @return result OK in case of success.
* NOT_SUPPORTED if the tuner doesn't support announcements.
* @return closeHandle A handle to unregister observer,
* nullptr if result was not OK.
*/
- registerAnnouncementObserver(
+ registerAnnouncementListener(
vec<AnnouncementType> enabled,
- IAnnouncementObserver cb
+ IAnnouncementListener listener
) generates (
Result result,
ICloseHandle closeHandle
diff --git a/broadcastradio/2.0/default/BroadcastRadio.cpp b/broadcastradio/2.0/default/BroadcastRadio.cpp
index d16aaff..aa5afad 100644
--- a/broadcastradio/2.0/default/BroadcastRadio.cpp
+++ b/broadcastradio/2.0/default/BroadcastRadio.cpp
@@ -141,9 +141,9 @@
return {};
}
-Return<void> BroadcastRadio::registerAnnouncementObserver(
- const hidl_vec<AnnouncementType>& enabled, const sp<IAnnouncementObserver>& /* cb */,
- registerAnnouncementObserver_cb _hidl_cb) {
+Return<void> BroadcastRadio::registerAnnouncementListener(
+ const hidl_vec<AnnouncementType>& enabled, const sp<IAnnouncementListener>& /* listener */,
+ registerAnnouncementListener_cb _hidl_cb) {
ALOGV("%s(%s)", __func__, toString(enabled).c_str());
_hidl_cb(Result::NOT_SUPPORTED, nullptr);
diff --git a/broadcastradio/2.0/default/BroadcastRadio.h b/broadcastradio/2.0/default/BroadcastRadio.h
index 7904946..8c14d9e 100644
--- a/broadcastradio/2.0/default/BroadcastRadio.h
+++ b/broadcastradio/2.0/default/BroadcastRadio.h
@@ -36,9 +36,9 @@
Return<void> getDabRegionConfig(getDabRegionConfig_cb _hidl_cb);
Return<void> openSession(const sp<ITunerCallback>& callback, openSession_cb _hidl_cb) override;
Return<void> getImage(uint32_t id, getImage_cb _hidl_cb);
- Return<void> registerAnnouncementObserver(const hidl_vec<AnnouncementType>& enabled,
- const sp<IAnnouncementObserver>& cb,
- registerAnnouncementObserver_cb _hidl_cb);
+ Return<void> registerAnnouncementListener(const hidl_vec<AnnouncementType>& enabled,
+ const sp<IAnnouncementListener>& listener,
+ registerAnnouncementListener_cb _hidl_cb);
std::reference_wrapper<const VirtualRadio> mVirtualRadio;
Properties mProperties;
diff --git a/broadcastradio/2.0/vts/functional/VtsHalBroadcastradioV2_0TargetTest.cpp b/broadcastradio/2.0/vts/functional/VtsHalBroadcastradioV2_0TargetTest.cpp
index 1111478..8d9d622 100644
--- a/broadcastradio/2.0/vts/functional/VtsHalBroadcastradioV2_0TargetTest.cpp
+++ b/broadcastradio/2.0/vts/functional/VtsHalBroadcastradioV2_0TargetTest.cpp
@@ -90,7 +90,7 @@
utils::ProgramInfoSet mProgramList;
};
-struct AnnouncementObserverMock : public IAnnouncementObserver {
+struct AnnouncementListenerMock : public IAnnouncementListener {
MOCK_METHOD1(onListUpdated, Return<void>(const hidl_vec<Announcement>&));
};
@@ -702,15 +702,15 @@
}
/**
- * Test announcement observer registration.
+ * Test announcement listener registration.
*
* Verifies that:
- * - registerAnnouncementObserver either succeeds or returns NOT_SUPPORTED;
+ * - registerAnnouncementListener either succeeds or returns NOT_SUPPORTED;
* - if it succeeds, it returns a valid close handle (which is a nullptr otherwise);
* - closing handle does not crash.
*/
-TEST_F(BroadcastRadioHalTest, AnnouncementObserverRegistration) {
- sp<AnnouncementObserverMock> observer = new AnnouncementObserverMock();
+TEST_F(BroadcastRadioHalTest, AnnouncementListenerRegistration) {
+ sp<AnnouncementListenerMock> listener = new AnnouncementListenerMock();
Result halResult = Result::UNKNOWN_ERROR;
sp<ICloseHandle> closeHandle = nullptr;
@@ -720,7 +720,7 @@
};
auto hidlResult =
- mModule->registerAnnouncementObserver({AnnouncementType::EMERGENCY}, observer, cb);
+ mModule->registerAnnouncementListener({AnnouncementType::EMERGENCY}, listener, cb);
ASSERT_TRUE(hidlResult.isOk());
if (halResult == Result::NOT_SUPPORTED) {
