blob: 6e5cd8fc3b1a8f8a9991e6656e5d2d142fb9b0c7 [file] [log] [blame]
// Copyright (c) 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "base/basictypes.h"
#include "components/gcm_driver/gcm_client.h"
namespace gcm {
// Defines the interface to provide handling and event routing logic for a given
// app.
class GCMAppHandler {
virtual ~GCMAppHandler();
// Called to do all the cleanup when GCM is shutting down.
// In the case that multiple apps share the same app handler, it should be
// make safe for ShutdownHandler to be called multiple times.
virtual void ShutdownHandler() = 0;
// Called when a GCM message has been received.
virtual void OnMessage(const std::string& app_id,
const GCMClient::IncomingMessage& message) = 0;
// Called when some GCM messages have been deleted from the server.
virtual void OnMessagesDeleted(const std::string& app_id) = 0;
// Called when a GCM message failed to be delivered.
virtual void OnSendError(
const std::string& app_id,
const GCMClient::SendErrorDetails& send_error_details) = 0;
// Called when a new connection is established and a successful handshake
// has been performed. Note that |ip_endpoint| is only set if available for
// the current platform.
// Default implementation does nothing.
virtual void OnConnected(const net::IPEndPoint& ip_endpoint);
// Called when the connection is interrupted.
// Default implementation does nothing.
virtual void OnDisconnected();
// If no app handler has been added with the exact app_id of an incoming
// event, all handlers will be asked (in arbitrary order) whether they can
// handle the app_id, and the first to return true will receive the event.
virtual bool CanHandle(const std::string& app_id) const;
} // namespace gcm