Skip to content

Commit

Permalink
add JniGlobalReference class with move constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
@yunhanw-google
yunhanw-google committed Oct 13, 2023
1 parent 7d2c9ce commit a16c105
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 40 deletions.
47 changes: 14 additions & 33 deletions src/controller/java/AndroidCallbacks.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
#include <lib/support/CHIPJNIError.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/JniReferences.h>
#include <lib/support/JniTypeWrappers.h>
#include <lib/support/jsontlv/JsonToTlv.h>
#include <lib/support/jsontlv/TlvToJson.h>
#include <lib/support/logging/CHIPLogging.h>
Expand Down Expand Up @@ -76,11 +75,7 @@ GetConnectedDeviceCallback::GetConnectedDeviceCallback(jobject wrapperCallback,
{
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));
mWrapperCallbackRef = env->NewGlobalRef(wrapperCallback);
if (mWrapperCallbackRef == nullptr)
{
ChipLogError(Controller, "Could not create global reference for Java callback");
}
VerifyOrReturn(mWrapperCallbackRef.Init(env, wrapperCallback) != CHIP_NO_ERROR, ChipLogError(Controller, "Could not init mWrapperCallbackRef for GetConnectedDeviceCallback"));
mJavaCallbackRef = env->NewGlobalRef(javaCallback);
if (mJavaCallbackRef == nullptr)
{
Expand All @@ -107,8 +102,7 @@ void GetConnectedDeviceCallback::OnDeviceConnectedFn(void * context, Messaging::
jobject javaCallback = self->mJavaCallbackRef;
JniLocalReferenceManager manager(env);
// Release wrapper's global ref so application can clean up the actual callback underneath.
VerifyOrReturn(self->mWrapperCallbackRef != nullptr, ChipLogError(Controller, "mWrapperCallbackRef is null"));
JniObject wrapper(env, self->mWrapperCallbackRef);
JniGlobalReference globalRef(std::move(self->mWrapperCallbackRef));

jclass getConnectedDeviceCallbackCls = nullptr;
JniReferences::GetInstance().GetLocalClassRef(
Expand Down Expand Up @@ -178,11 +172,9 @@ ReportCallback::ReportCallback(jobject wrapperCallback, jobject subscriptionEsta
{
ChipLogError(Controller, "Could not create global reference for Java callback");
}
mWrapperCallbackRef = env->NewGlobalRef(wrapperCallback);
if (mWrapperCallbackRef == nullptr)
{
ChipLogError(Controller, "Could not create global reference for Java callback");
}

VerifyOrReturn(mWrapperCallbackRef.Init(env, wrapperCallback) != CHIP_NO_ERROR, ChipLogError(Controller, "Could not init mWrapperCallbackRef for ReportCallback"));

if (resubscriptionAttemptCallback != nullptr)
{
mResubscriptionAttemptCallbackRef = env->NewGlobalRef(resubscriptionAttemptCallback);
Expand Down Expand Up @@ -591,8 +583,8 @@ void ReportCallback::OnDone(app::ReadClient *)
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));
JniLocalReferenceManager manager(env);
VerifyOrReturn(mWrapperCallbackRef != nullptr, ChipLogError(Controller, "mWrapperCallbackRef is null"));
JniObject wrapper(env, mWrapperCallbackRef);
VerifyOrReturn(mWrapperCallbackRef.HasValidObjectRef(), ChipLogError(Controller, "mWrapperCallbackRef is nullptr in ReportCallback::OnDone"));
JniGlobalReference globalRef(std::move(mWrapperCallbackRef));
jmethodID onDoneMethod;
err = JniReferences::GetInstance().FindMethod(env, mReportCallbackRef, "onDone", "()V", &onDoneMethod);
VerifyOrReturn(err == CHIP_NO_ERROR, ChipLogError(Controller, "Could not find onDone method"));
Expand Down Expand Up @@ -677,13 +669,7 @@ WriteAttributesCallback::WriteAttributesCallback(jobject wrapperCallback, jobjec
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));

mWrapperCallbackRef = env->NewGlobalRef(wrapperCallback);
VerifyOrReturn(!env->ExceptionCheck(), env->ExceptionDescribe());
if (mWrapperCallbackRef == nullptr)
{
ChipLogError(Controller, "Could not create global reference for Wrapper WriteAttributesCallback");
return;
}
VerifyOrReturn(mWrapperCallbackRef.Init(env, wrapperCallback) != CHIP_NO_ERROR, ChipLogError(Controller, "Could not init mWrapperCallbackRef for WriteAttributesCallback"));
mJavaCallbackRef = env->NewGlobalRef(javaCallback);
VerifyOrReturn(!env->ExceptionCheck(), env->ExceptionDescribe());
if (mJavaCallbackRef == nullptr)
Expand Down Expand Up @@ -747,8 +733,8 @@ void WriteAttributesCallback::OnDone(app::WriteClient *)
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));
JniLocalReferenceManager manager(env);
VerifyOrReturn(mWrapperCallbackRef != nullptr, ChipLogError(Controller, "mWrapperCallbackRef is null"));
JniObject wrapper(env, mWrapperCallbackRef);
VerifyOrReturn(mWrapperCallbackRef.HasValidObjectRef(), ChipLogError(Controller, "mWrapperCallbackRef is nullptr in WriteAttributesCallback::OnDone"));
JniGlobalReference globalRef(std::move(mWrapperCallbackRef));
jmethodID onDoneMethod;
err = JniReferences::GetInstance().FindMethod(env, mJavaCallbackRef, "onDone", "()V", &onDoneMethod);
VerifyOrReturn(err == CHIP_NO_ERROR, ChipLogError(Controller, "Could not find onDone method"));
Expand Down Expand Up @@ -796,13 +782,8 @@ InvokeCallback::InvokeCallback(jobject wrapperCallback, jobject javaCallback)
{
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));
mWrapperCallbackRef = env->NewGlobalRef(wrapperCallback);
VerifyOrReturn(!env->ExceptionCheck(), env->ExceptionDescribe());
if (mWrapperCallbackRef == nullptr)
{
ChipLogError(Controller, "Could not create global reference for Wrapper InvokeCallback");
return;
}
VerifyOrReturn(mWrapperCallbackRef.Init(env, wrapperCallback) != CHIP_NO_ERROR, ChipLogError(Controller, "Could not init mWrapperCallbackRef for InvokeCallback"));

mJavaCallbackRef = env->NewGlobalRef(javaCallback);
VerifyOrReturn(!env->ExceptionCheck(), env->ExceptionDescribe());
if (mJavaCallbackRef == nullptr)
Expand Down Expand Up @@ -867,8 +848,8 @@ void InvokeCallback::OnDone(app::CommandSender * apCommandSender)
JNIEnv * env = JniReferences::GetInstance().GetEnvForCurrentThread();
VerifyOrReturn(env != nullptr, ChipLogError(Controller, "Could not get JNIEnv for current thread"));
JniLocalReferenceManager manager(env);
VerifyOrReturn(mWrapperCallbackRef != nullptr, ChipLogError(Controller, "mWrapperCallbackRef is null"));
JniObject wrapper(env, mWrapperCallbackRef);
VerifyOrReturn(mWrapperCallbackRef.HasValidObjectRef(), ChipLogError(Controller, "mWrapperCallbackRef is nullptr in InvokeCallback::OnDone"));
JniGlobalReference globalRef(std::move(mWrapperCallbackRef));
jmethodID onDoneMethod;
err = JniReferences::GetInstance().FindMethod(env, mJavaCallbackRef, "onDone", "()V", &onDoneMethod);
VerifyOrReturn(err == CHIP_NO_ERROR, ChipLogError(Controller, "Could not find onDone method"));
Expand Down
9 changes: 5 additions & 4 deletions src/controller/java/AndroidCallbacks.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
#include <lib/core/CHIPError.h>
#include <list>
#include <utility>
#include <lib/support/JniTypeWrappers.h>

namespace chip {
namespace Controller {
Expand All @@ -42,7 +43,7 @@ struct GetConnectedDeviceCallback

Callback::Callback<OnDeviceConnected> mOnSuccess;
Callback::Callback<OnDeviceConnectionFailure> mOnFailure;
jobject mWrapperCallbackRef = nullptr;
JniGlobalReference mWrapperCallbackRef;
jobject mJavaCallbackRef = nullptr;
};

Expand Down Expand Up @@ -83,7 +84,7 @@ struct ReportCallback : public app::ClusterStateCache::Callback
app::ReadClient * mReadClient = nullptr;

app::ClusterStateCache mClusterCacheAdapter;
jobject mWrapperCallbackRef = nullptr;
JniGlobalReference mWrapperCallbackRef;
jobject mSubscriptionEstablishedCallbackRef = nullptr;
jobject mResubscriptionAttemptCallbackRef = nullptr;
jobject mReportCallbackRef = nullptr;
Expand All @@ -110,7 +111,7 @@ struct WriteAttributesCallback : public app::WriteClient::Callback

app::WriteClient * mWriteClient = nullptr;
app::ChunkedWriteCallback mChunkedWriteCallback;
jobject mWrapperCallbackRef = nullptr;
JniGlobalReference mWrapperCallbackRef;
jobject mJavaCallbackRef = nullptr;
};

Expand All @@ -132,7 +133,7 @@ struct InvokeCallback : public app::CommandSender::Callback
void ReportError(const char * message, ChipError::StorageType errorCode);

app::CommandSender * mCommandSender = nullptr;
jobject mWrapperCallbackRef = nullptr;
JniGlobalReference mWrapperCallbackRef;
jobject mJavaCallbackRef = nullptr;
};

Expand Down
34 changes: 31 additions & 3 deletions src/lib/support/JniTypeWrappers.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include <cstdint>
#include <jni.h>
#include <lib/support/JniReferences.h>
#include <lib/support/CHIPJNIError.h>
#include <lib/support/Span.h>
#include <string>

Expand Down Expand Up @@ -203,11 +204,33 @@ class JniLocalReferenceManager
bool mlocalFramePushed = false;
};

class JniObject
class JniGlobalReference
{
public:
JniObject(JNIEnv * aEnv, jobject aObjectRef) : mEnv(aEnv), mObjectRef(aObjectRef) {}
~JniObject()
JniGlobalReference() {}

CHIP_ERROR Init(JNIEnv * aEnv, jobject aObjectRef)
{
VerifyOrReturnError(mEnv != nullptr && mObjectRef != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(aEnv != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
mEnv = aEnv;
mObjectRef = mEnv->NewGlobalRef(aObjectRef);
VerifyOrReturnError(!mEnv->ExceptionCheck(), CHIP_JNI_ERROR_EXCEPTION_THROWN);
VerifyOrReturnError(mObjectRef != nullptr, CHIP_JNI_ERROR_NULL_OBJECT);
return CHIP_NO_ERROR;
}

JniGlobalReference(JniGlobalReference && aOther) {
// Assign the other object's JNI environment and object reference to our own.
mEnv = aOther.mEnv;
mObjectRef = aOther.mObjectRef;

// Set the other object's JNI environment and object reference to nullptr to prevent it from freeing the resources twice.
aOther.mEnv = nullptr;
aOther.mObjectRef = nullptr;
}

~JniGlobalReference()
{
if (mEnv != nullptr && mObjectRef != nullptr)
{
Expand All @@ -217,6 +240,11 @@ class JniObject

jobject objectRef() { return mObjectRef; }

bool HasValidObjectRef()
{
return mObjectRef != nullptr;
}

private:
JNIEnv * mEnv = nullptr;
jobject mObjectRef = nullptr;
Expand Down

0 comments on commit a16c105

Please sign in to comment.