src/third_party/cacheinvalidation/src/java/com/google/ipc/invalidation/external/client/android/AndroidInvalidationClient.java

   1 /*
   2  * Copyright 2011 Google Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.ipc.invalidation.external.client.android;
  18
  19 import com.google.ipc.invalidation.external.client.InvalidationClient;
  20
  21 /**
  22  * Extends the {@link InvalidationClient} interface to add Android-specific
  23  * client functionality.
  24  *
  25  */
  26 public interface AndroidInvalidationClient extends InvalidationClient {
  27   /**
  28    * Returns the client key that uniquely identifies this client.   The client key can be passed
  29    * to {@link AndroidClientFactory#resume} to resume processing with the client instance that
  30    * is identified by this.
  31    */
  32   public String getClientKey();
  33
  34   /**
  35    * Releases any transient resources associated with the client such as connections to bound
  36    * services.
  37    */
  38   public void release();
  39
  40   /**
  41    * Permanently destroys the client and all associated state.
  42    */
  43   public void destroy();
  44 }