Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2cbaf22b authored by Etan Cohen's avatar Etan Cohen
Browse files

[AWARE] Remove Publish/Subscribe Count configuration 

Simplify API: semantics of publish/subscribe count restrictions
aren't clear at the app level. They depend on DW configuration as
well as discovery session type - number of packets transmitted over
the air.

There's already an app-facing discovery session lifetime configuration -
the TTL. That has clearer semantics and is sufficient (for now).

Bug: 36446307
Test: unit tests and integration (sl4a) tests.
Change-Id: I9129975bd2e1a61b3d23a4b6acaae703b42216c7
parent afddcc3c

api/current.txt

+0 −2
Original line number Diff line number Diff line
@@ -25189,7 +25189,6 @@ package android.net.wifi.aware { 
    ctor public PublishConfig.Builder();

    method public android.net.wifi.aware.PublishConfig build();

    method public android.net.wifi.aware.PublishConfig.Builder setMatchFilter(java.util.List<byte[]>);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishCount(int);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishType(int);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceSpecificInfo(byte[]);
@@ -25218,7 +25217,6 @@ package android.net.wifi.aware { 
    method public android.net.wifi.aware.SubscribeConfig.Builder setMatchStyle(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceSpecificInfo(byte[]);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeCount(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeType(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTerminateNotificationEnabled(boolean);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTtlSec(int);

api/system-current.txt

+0 −2
Original line number Diff line number Diff line
@@ -27749,7 +27749,6 @@ package android.net.wifi.aware { 
    ctor public PublishConfig.Builder();

    method public android.net.wifi.aware.PublishConfig build();

    method public android.net.wifi.aware.PublishConfig.Builder setMatchFilter(java.util.List<byte[]>);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishCount(int);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishType(int);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceSpecificInfo(byte[]);
@@ -27778,7 +27777,6 @@ package android.net.wifi.aware { 
    method public android.net.wifi.aware.SubscribeConfig.Builder setMatchStyle(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceSpecificInfo(byte[]);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeCount(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeType(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTerminateNotificationEnabled(boolean);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTtlSec(int);

api/test-current.txt

+0 −2
Original line number Diff line number Diff line
@@ -25262,7 +25262,6 @@ package android.net.wifi.aware { 
    ctor public PublishConfig.Builder();

    method public android.net.wifi.aware.PublishConfig build();

    method public android.net.wifi.aware.PublishConfig.Builder setMatchFilter(java.util.List<byte[]>);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishCount(int);

    method public android.net.wifi.aware.PublishConfig.Builder setPublishType(int);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.PublishConfig.Builder setServiceSpecificInfo(byte[]);
@@ -25291,7 +25290,6 @@ package android.net.wifi.aware { 
    method public android.net.wifi.aware.SubscribeConfig.Builder setMatchStyle(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceName(java.lang.String);

    method public android.net.wifi.aware.SubscribeConfig.Builder setServiceSpecificInfo(byte[]);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeCount(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setSubscribeType(int);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTerminateNotificationEnabled(boolean);

    method public android.net.wifi.aware.SubscribeConfig.Builder setTtlSec(int);

wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java

+1 −1
Original line number Diff line number Diff line
@@ -85,7 +85,7 @@ public class DiscoverySessionCallback { 
    /**

     * Called when a discovery session (publish or subscribe) terminates. Termination may be due

     * to user-request (either directly through {@link DiscoverySession#destroy()} or

     * application-specified expiration, e.g. {@link PublishConfig.Builder#setPublishCount(int)}

     * application-specified expiration, e.g. {@link PublishConfig.Builder#setTtlSec(int)}

     * or {@link SubscribeConfig.Builder#setTtlSec(int)}).

     */

    public void onSessionTerminated() {

wifi/java/android/net/wifi/aware/PublishConfig.java

+6 −41
Original line number Diff line number Diff line
@@ -74,9 +74,6 @@ public final class PublishConfig implements Parcelable { 
    /** @hide */

    public final int mPublishType;



    /** @hide */

    public final int mPublishCount;



    /** @hide */

    public final int mTtlSec;
@@ -85,12 +82,11 @@ public final class PublishConfig implements Parcelable { 


    /** @hide */

    public PublishConfig(byte[] serviceName, byte[] serviceSpecificInfo, byte[] matchFilter,

            int publishType, int publichCount, int ttlSec, boolean enableTerminateNotification) {

            int publishType, int ttlSec, boolean enableTerminateNotification) {

        mServiceName = serviceName;

        mServiceSpecificInfo = serviceSpecificInfo;

        mMatchFilter = matchFilter;

        mPublishType = publishType;

        mPublishCount = publichCount;

        mTtlSec = ttlSec;

        mEnableTerminateNotification = enableTerminateNotification;

    }
@@ -100,8 +96,8 @@ public final class PublishConfig implements Parcelable { 
        return "PublishConfig [mServiceName='" + mServiceName + ", mServiceSpecificInfo='" + (

                (mServiceSpecificInfo == null) ? "null" : HexEncoding.encode(mServiceSpecificInfo))

                + ", mMatchFilter=" + (new TlvBufferUtils.TlvIterable(0, 1,

                mMatchFilter)).toString() + ", mPublishType=" + mPublishType + ", mPublishCount="

                + mPublishCount + ", mTtlSec=" + mTtlSec + ", mEnableTerminateNotification="

                mMatchFilter)).toString() + ", mPublishType=" + mPublishType

                + ", mTtlSec=" + mTtlSec + ", mEnableTerminateNotification="

                + mEnableTerminateNotification + "]";

    }
@@ -116,7 +112,6 @@ public final class PublishConfig implements Parcelable { 
        dest.writeByteArray(mServiceSpecificInfo);

        dest.writeByteArray(mMatchFilter);

        dest.writeInt(mPublishType);

        dest.writeInt(mPublishCount);

        dest.writeInt(mTtlSec);

        dest.writeInt(mEnableTerminateNotification ? 1 : 0);

    }
@@ -133,11 +128,10 @@ public final class PublishConfig implements Parcelable { 
            byte[] ssi = in.createByteArray();

            byte[] matchFilter = in.createByteArray();

            int publishType = in.readInt();

            int publishCount = in.readInt();

            int ttlSec = in.readInt();

            boolean enableTerminateNotification = in.readInt() != 0;



            return new PublishConfig(serviceName, ssi, matchFilter, publishType, publishCount,

            return new PublishConfig(serviceName, ssi, matchFilter, publishType,

                    ttlSec, enableTerminateNotification);

        }

    };
@@ -156,7 +150,7 @@ public final class PublishConfig implements Parcelable { 


        return Arrays.equals(mServiceName, lhs.mServiceName) && Arrays.equals(mServiceSpecificInfo,

                lhs.mServiceSpecificInfo) && Arrays.equals(mMatchFilter, lhs.mMatchFilter)

                && mPublishType == lhs.mPublishType && mPublishCount == lhs.mPublishCount

                && mPublishType == lhs.mPublishType

                && mTtlSec == lhs.mTtlSec

                && mEnableTerminateNotification == lhs.mEnableTerminateNotification;

    }
@@ -169,7 +163,6 @@ public final class PublishConfig implements Parcelable { 
        result = 31 * result + Arrays.hashCode(mServiceSpecificInfo);

        result = 31 * result + Arrays.hashCode(mMatchFilter);

        result = 31 * result + mPublishType;

        result = 31 * result + mPublishCount;

        result = 31 * result + mTtlSec;

        result = 31 * result + (mEnableTerminateNotification ? 1 : 0);
@@ -193,9 +186,6 @@ public final class PublishConfig implements Parcelable { 
        if (mPublishType < PUBLISH_TYPE_UNSOLICITED || mPublishType > PUBLISH_TYPE_SOLICITED) {

            throw new IllegalArgumentException("Invalid publishType - " + mPublishType);

        }

        if (mPublishCount < 0) {

            throw new IllegalArgumentException("Invalid publishCount - must be non-negative");

        }

        if (mTtlSec < 0) {

            throw new IllegalArgumentException("Invalid ttlSec - must be non-negative");

        }
@@ -229,7 +219,6 @@ public final class PublishConfig implements Parcelable { 
        private byte[] mServiceSpecificInfo;

        private byte[] mMatchFilter;

        private int mPublishType = PUBLISH_TYPE_UNSOLICITED;

        private int mPublishCount = 0;

        private int mTtlSec = 0;

        private boolean mEnableTerminateNotification = true;
@@ -316,30 +305,6 @@ public final class PublishConfig implements Parcelable { 
            return this;

        }



        /**

         * Sets the number of times an unsolicited (configured using

         * {@link PublishConfig.Builder#setPublishType(int)}) publish session

         * will be broadcast. When the count is reached an event will be

         * generated for {@link DiscoverySessionCallback#onSessionTerminated()}

         * [unless {@link #setTerminateNotificationEnabled(boolean)} disables the callback].

         * <p>

         *     Optional. 0 by default - indicating the session doesn't terminate on its own.

         *     Session will be terminated when {@link DiscoverySession#destroy()} is

         *     called.

         *

         * @param publishCount Number of publish packets to broadcast.

         *

         * @return The builder to facilitate chaining

         *         {@code builder.setXXX(..).setXXX(..)}.

         */

        public Builder setPublishCount(int publishCount) {

            if (publishCount < 0) {

                throw new IllegalArgumentException("Invalid publishCount - must be non-negative");

            }

            mPublishCount = publishCount;

            return this;

        }



        /**

         * Sets the time interval (in seconds) an unsolicited (

         * {@link PublishConfig.Builder#setPublishType(int)}) publish session
@@ -387,7 +352,7 @@ public final class PublishConfig implements Parcelable { 
         */

        public PublishConfig build() {

            return new PublishConfig(mServiceName, mServiceSpecificInfo, mMatchFilter, mPublishType,

                    mPublishCount, mTtlSec, mEnableTerminateNotification);

                    mTtlSec, mEnableTerminateNotification);

        }

    }

}