Rename AnnouncementObserver to AnnouncementListener.

I feel this wording match java naming more closely.

Bug: 68045105
Test: VTS
Change-Id: If30fa9b356b6b45fe8853bc5194c7098d0fb2aa5
This commit is contained in:
Tomasz Wasilczyk
2018-01-10 10:58:20 -08:00
parent 6118ea4d97
commit 0d5ef5de01
6 changed files with 21 additions and 21 deletions

View File

@@ -8,7 +8,7 @@ hidl_interface {
},
srcs: [
"types.hal",
"IAnnouncementObserver.hal",
"IAnnouncementListener.hal",
"IBroadcastRadio.hal",
"ICloseHandle.hal",
"ITunerCallback.hal",

View File

@@ -16,11 +16,11 @@
package android.hardware.broadcastradio@2.0;
/**
* 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.
*

View File

@@ -15,7 +15,7 @@
package android.hardware.broadcastradio@2.0;
import IAnnouncementObserver;
import IAnnouncementListener;
import ICloseHandle;
import ITunerCallback;
import ITunerSession;
@@ -104,7 +104,7 @@ interface IBroadcastRadio {
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 @@ interface IBroadcastRadio {
* 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

View File

@@ -141,9 +141,9 @@ Return<void> BroadcastRadio::getImage(uint32_t id, getImage_cb _hidl_cb) {
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);

View File

@@ -36,9 +36,9 @@ struct BroadcastRadio : public IBroadcastRadio {
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;

View File

@@ -90,7 +90,7 @@ class TunerCallbackMock : public ITunerCallback {
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_F(BroadcastRadioHalTest, HdRadioStationNameId) {
}
/**
* 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 @@ TEST_F(BroadcastRadioHalTest, AnnouncementObserverRegistration) {
};
auto hidlResult =
mModule->registerAnnouncementObserver({AnnouncementType::EMERGENCY}, observer, cb);
mModule->registerAnnouncementListener({AnnouncementType::EMERGENCY}, listener, cb);
ASSERT_TRUE(hidlResult.isOk());
if (halResult == Result::NOT_SUPPORTED) {