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

Commit 12213fb1 authored by Etan Cohen's avatar Etan Cohen
Browse files

[NAN] Expose match style configuration as public API. 

Match style allows apps to configure getting a single notification
or continuous notifications (for all matches).

(cherry-pick of 8ef74534)

Bug: 27568256
Change-Id: I9b7bd2e4e58af5c73188267d11c1288a93cf64ed
parent 9f09d21b

wifi/java/android/net/wifi/nan/PublishConfig.java

+5 −5
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import java.util.Arrays; 
/**

 * Defines the configuration of a NAN publish session. Built using

 * {@link PublishConfig.Builder}. Publish is done using

 * {@link WifiNanManager#publish(PublishConfig, WifiNanSessionListener, int)} or

 * {@link WifiNanManager#publish(PublishConfig, WifiNanSessionCallback, int)} or

 * {@link WifiNanPublishSession#publish(PublishConfig)}.

 *

 * @hide PROPOSED_NAN_API
@@ -402,8 +402,8 @@ public class PublishConfig implements Parcelable { 
         * Sets the number of times a solicited (

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

         * will transmit a packet. When the count is reached an event will be

         * generated for {@link WifiNanSessionListener#onPublishTerminated(int)}

         * with reason={@link WifiNanSessionListener#TERMINATE_REASON_DONE}.

         * generated for {@link WifiNanSessionCallback#onPublishTerminated(int)}

         * with reason={@link WifiNanSessionCallback#TERMINATE_REASON_DONE}.

         *

         * @param publishCount Number of publish packets to transmit.

         * @return The builder to facilitate chaining
@@ -422,8 +422,8 @@ public class PublishConfig implements Parcelable { 
         * {@link PublishConfig.Builder#setPublishCount(int)}) publish session

         * will be alive - i.e. transmitting a packet. When the TTL is reached

         * an event will be generated for

         * {@link WifiNanSessionListener#onPublishTerminated(int)} with reason=

         * {@link WifiNanSessionListener#TERMINATE_REASON_DONE}.

         * {@link WifiNanSessionCallback#onPublishTerminated(int)} with reason=

         * {@link WifiNanSessionCallback#TERMINATE_REASON_DONE}.

         *

         * @param ttlSec Lifetime of a publish session in seconds.

         * @return The builder to facilitate chaining

wifi/java/android/net/wifi/nan/SubscribeConfig.java

+57 −13
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import java.util.Arrays; 
/**

 * Defines the configuration of a NAN subscribe session. Built using

 * {@link SubscribeConfig.Builder}. Subscribe is done using

 * {@link WifiNanManager#subscribe(SubscribeConfig, WifiNanSessionListener, int)}

 * {@link WifiNanManager#subscribe(SubscribeConfig, WifiNanSessionCallback, int)}

 * or {@link WifiNanSubscribeSession#subscribe(SubscribeConfig)}.

 *

 * @hide PROPOSED_NAN_API
@@ -46,6 +46,18 @@ public class SubscribeConfig implements Parcelable { 
     */

    public static final int SUBSCRIBE_TYPE_ACTIVE = 1;



    /**

     * Specifies that only the first match of a set of identical matches (same

     * publish) will be reported to the subscriber.

     */

    public static final int MATCH_STYLE_FIRST_ONLY = 0;



    /**

     * Specifies that all matches of a set of identical matches (same publish)

     * will be reported to the subscriber.

     */

    public static final int MATCH_STYLE_ALL = 1;



    /**

     * @hide

     */
@@ -96,9 +108,14 @@ public class SubscribeConfig implements Parcelable { 
     */

    public final int mTtlSec;



    /**

     * @hide

     */

    public final int mMatchStyle;



    private SubscribeConfig(String serviceName, byte[] serviceSpecificInfo,

            int serviceSpecificInfoLength, byte[] txFilter, int txFilterLength, byte[] rxFilter,

            int rxFilterLength, int subscribeType, int publichCount, int ttlSec) {

            int rxFilterLength, int subscribeType, int publichCount, int ttlSec, int matchStyle) {

        mServiceName = serviceName;

        mServiceSpecificInfoLength = serviceSpecificInfoLength;

        mServiceSpecificInfo = serviceSpecificInfo;
@@ -109,6 +126,7 @@ public class SubscribeConfig implements Parcelable { 
        mSubscribeType = subscribeType;

        mSubscribeCount = publichCount;

        mTtlSec = ttlSec;

        mMatchStyle = matchStyle;

    }



    @Override
@@ -120,7 +138,7 @@ public class SubscribeConfig implements Parcelable { 
                + ", mRxFilter="

                + (new TlvBufferUtils.TlvIterable(0, 1, mRxFilter, mRxFilterLength)).toString()

                + ", mSubscribeType=" + mSubscribeType + ", mSubscribeCount=" + mSubscribeCount

                + ", mTtlSec=" + mTtlSec + "']";

                + ", mTtlSec=" + mTtlSec + ", mMatchType=" + mMatchStyle + "']";

    }



    @Override
@@ -146,6 +164,7 @@ public class SubscribeConfig implements Parcelable { 
        dest.writeInt(mSubscribeType);

        dest.writeInt(mSubscribeCount);

        dest.writeInt(mTtlSec);

        dest.writeInt(mMatchStyle);

    }



    public static final Creator<SubscribeConfig> CREATOR = new Creator<SubscribeConfig>() {
@@ -175,8 +194,9 @@ public class SubscribeConfig implements Parcelable { 
            int subscribeType = in.readInt();

            int subscribeCount = in.readInt();

            int ttlSec = in.readInt();

            int matchStyle = in.readInt();

            return new SubscribeConfig(serviceName, ssi, ssiLength, txFilter, txFilterLength,

                    rxFilter, rxFilterLength, subscribeType, subscribeCount, ttlSec);

                    rxFilter, rxFilterLength, subscribeType, subscribeCount, ttlSec, matchStyle);

        }

    };
@@ -230,7 +250,7 @@ public class SubscribeConfig implements Parcelable { 
        }



        return mSubscribeType == lhs.mSubscribeType && mSubscribeCount == lhs.mSubscribeCount

                && mTtlSec == lhs.mTtlSec;

                && mTtlSec == lhs.mTtlSec && mMatchStyle == lhs.mMatchStyle;

    }



    @Override
@@ -247,6 +267,7 @@ public class SubscribeConfig implements Parcelable { 
        result = 31 * result + mSubscribeType;

        result = 31 * result + mSubscribeCount;

        result = 31 * result + mTtlSec;

        result = 31 * result + mMatchStyle;



        return result;

    }
@@ -262,9 +283,10 @@ public class SubscribeConfig implements Parcelable { 
        private byte[] mTxFilter = new byte[0];

        private int mRxFilterLength;

        private byte[] mRxFilter = new byte[0];

        private int mSubscribeType;

        private int mSubscribeCount;

        private int mTtlSec;

        private int mSubscribeType = SUBSCRIBE_TYPE_PASSIVE;

        private int mSubscribeCount = 0;

        private int mTtlSec = 0;

        private int mMatchStyle = MATCH_STYLE_ALL;



        /**

         * Specify the service name of the subscribe session. The actual on-air
@@ -390,8 +412,8 @@ public class SubscribeConfig implements Parcelable { 
         * {@link SubscribeConfig.Builder#setSubscribeType(int)}) subscribe

         * session will transmit a packet. When the count is reached an event

         * will be generated for

         * {@link WifiNanSessionListener#onSubscribeTerminated(int)} with

         * reason= {@link WifiNanSessionListener#TERMINATE_REASON_DONE}.

         * {@link WifiNanSessionCallback#onSubscribeTerminated(int)} with

         * reason= {@link WifiNanSessionCallback#TERMINATE_REASON_DONE}.

         *

         * @param subscribeCount Number of subscribe packets to transmit.

         * @return The builder to facilitate chaining
@@ -410,8 +432,8 @@ public class SubscribeConfig implements Parcelable { 
         * {@link SubscribeConfig.Builder#setSubscribeType(int)}) subscribe

         * session will be alive - i.e. transmitting a packet. When the TTL is

         * reached an event will be generated for

         * {@link WifiNanSessionListener#onSubscribeTerminated(int)} with

         * reason= {@link WifiNanSessionListener#TERMINATE_REASON_DONE}.

         * {@link WifiNanSessionCallback#onSubscribeTerminated(int)} with

         * reason= {@link WifiNanSessionCallback#TERMINATE_REASON_DONE}.

         *

         * @param ttlSec Lifetime of a subscribe session in seconds.

         * @return The builder to facilitate chaining
@@ -425,6 +447,28 @@ public class SubscribeConfig implements Parcelable { 
            return this;

        }



        /**

         * Sets the match style of the subscription - how are matches from a

         * single match session (corresponding to the same publish action on the

         * peer) reported to the host (using the

         * {@link WifiNanSessionCallback#onMatch(int, byte[], int, byte[], int)}

         * ). The options are: only report the first match and ignore the rest

         * {@link SubscribeConfig#MATCH_STYLE_FIRST_ONLY} or report every single

         * match {@link SubscribeConfig#MATCH_STYLE_ALL}.

         *

         * @param matchStyle The reporting style for the discovery match.

         * @return The builder to facilitate chaining

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

         */

        public Builder setMatchStyle(int matchStyle) {

            if (matchStyle != MATCH_STYLE_FIRST_ONLY && matchStyle != MATCH_STYLE_ALL) {

                throw new IllegalArgumentException(

                        "Invalid matchType - must be MATCH_FIRST_ONLY or MATCH_ALL");

            }

            mMatchStyle = matchStyle;

            return this;

        }



        /**

         * Build {@link SubscribeConfig} given the current requests made on the

         * builder.
@@ -432,7 +476,7 @@ public class SubscribeConfig implements Parcelable { 
        public SubscribeConfig build() {

            return new SubscribeConfig(mServiceName, mServiceSpecificInfo,

                    mServiceSpecificInfoLength, mTxFilter, mTxFilterLength, mRxFilter,

                    mRxFilterLength, mSubscribeType, mSubscribeCount, mTtlSec);

                    mRxFilterLength, mSubscribeType, mSubscribeCount, mTtlSec, mMatchStyle);

        }

    }

}

wifi/java/android/net/wifi/nan/WifiNanPublishSession.java

+2 −2
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ package android.net.wifi.nan; 


/**

 * A representation of a NAN publish session. Created when

 * {@link WifiNanManager#publish(PublishConfig, WifiNanSessionListener, int)} is

 * {@link WifiNanManager#publish(PublishConfig, WifiNanSessionCallback, int)} is

 * executed. The object can be used to stop and re-start (re-configure) the

 * publish session.

 *
@@ -34,7 +34,7 @@ public class WifiNanPublishSession extends WifiNanSession { 


    /**

     * Restart/re-configure the publish session. Note that the

     * {@link WifiNanSessionListener} is not replaced - the same listener used

     * {@link WifiNanSessionCallback} is not replaced - the same listener used

     * at creation is still used.

     *

     * @param publishConfig The configuration ({@link PublishConfig}) of the

wifi/java/android/net/wifi/nan/WifiNanSubscribeSession.java

+2 −2
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ package android.net.wifi.nan; 


/**

 * A representation of a NAN subscribe session. Created when

 * {@link WifiNanManager#subscribe(SubscribeConfig, WifiNanSessionListener, int)}

 * {@link WifiNanManager#subscribe(SubscribeConfig, WifiNanSessionCallback, int)}

 * is executed. The object can be used to stop and re-start (re-configure) the

 * subscribe session.

 *
@@ -34,7 +34,7 @@ public class WifiNanSubscribeSession extends WifiNanSession { 


    /**

     * Restart/re-configure the subscribe session. Note that the

     * {@link WifiNanSessionListener} is not replaced - the same listener used

     * {@link WifiNanSessionCallback} is not replaced - the same listener used

     * at creation is still used.

     *

     * @param subscribeConfig The configuration ({@link SubscribeConfig}) of the