com.cosmicpush.gateway.CosmicPushGateway Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2014 Jacob D. Parr
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.cosmicpush.gateway;

import com.cosmicpush.pub.common.*;
import com.cosmicpush.pub.common.PushResponse;

public interface CosmicPushGateway {

  /**
   * Sends a "PingPush" server which does not
   * result in any type of notification but
   * simply asserts that the service is alive.
   * @return the number of milliseconds elapsed.
   */
  public long ping();

  /**
   * Sends the Push to the server for processing.
   * @param push One of many types of Pushes.
   * @return the response from the push server.
   */
  public PushResponse send(Push push);

  /**
   * @see #send(com.cosmicpush.pub.common.Push)
   * @param push One of many types of Pushes.
   * @return the response from the push server.
   */
  @Deprecated
  public PushResponse push(Push push);
}