leaderboard.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 iFunFactory Inc. All Rights Reserved.
//
// This work is confidential and proprietary to iFunFactory Inc. and
// must not be used, disclosed, copied, or distributed without the prior
// consent of iFunFactory Inc.

#ifndef INCLUDE_FUNAPI_SERVICE_LEADERBOARD_H_
#define INCLUDE_FUNAPI_SERVICE_LEADERBOARD_H_

#include <funapi/player_account.h>
#include <funapi/time/wall_clock.h>
#include <funapi/types.h>

#include <sstream>
#include <vector>


namespace fun {

enum LeaderboardCollection {
  kSocial = 1,
  kPublic = 2
};


enum LeaderboardTimespan {
  kAllTime = 1,

  kDaily = 2,
  kWeekly = 3,
  kMonthly = 6,

  kYesterday = 5,
  kLastWeek = 4,
  kLastMonth = 7
};


struct FUNAPI_DLL_VISIBILITY LeaderboardRange {
  enum Type {
    kAll = 1,
    kFromTop = 2,
    kNearby = 3
  };

  LeaderboardRange();
  LeaderboardRange(const Type &in_type,
                   const int64_t &in_begin,
                   const int64_t &in_end);

  Type type;
  int64_t begin;
  int64_t end;
};


struct FUNAPI_DLL_VISIBILITY LeaderboardRecord {
  LeaderboardRecord(const int64_t &in_rank,
                    const PlayerAccount &in_player_account,
                    const double &in_score,
                    const double &in_percentage);

  int64_t rank;
  PlayerAccount player_account;
  double score;
  double percentage;
};


typedef std::vector<LeaderboardRecord> LeaderboardRecordVector;


enum LeaderboardScoreSubmissionResult {
  kNone = 1,
  kNewRecord = 2,
  kNewRecordDaily = 3,
  kNewRecordWeekly = 4,
  kNewRecordMonthly = 5
};


struct FUNAPI_DLL_VISIBILITY LeaderboardQueryRequest {
  enum RankingType {
    // Update score(do not get ranking)
    kNone = 0,
    // 1234 ranking
    kOrdinal = 1,
    // 1224 ranking
    kStdCompetition = 2,
    // 1223 ranking
    kDense = 3
  };

  // kPublic collection, kFromTop or kAll range
  LeaderboardQueryRequest(const string &in_leaderboard_id,
                          const LeaderboardTimespan &in_timespan,
                          const LeaderboardRange &in_range,
                          const RankingType &in_ranking_type = kOrdinal);
  // kPublic collection, kNearby range
  LeaderboardQueryRequest(const string &in_leaderboard_id,
                          const string &in_service_provider,
                          const string &in_id,
                          const LeaderboardTimespan &in_timespan,
                          const LeaderboardRange &in_range,
                          const RankingType &in_ranking_type = kOrdinal);
  // kSocial collection, kAll range
  LeaderboardQueryRequest(const string &in_leaderboard_id,
                          const string &in_service_provider,
                          const string &in_id,
                          const PlayerAccountVector &in_competitors,
                          const LeaderboardTimespan &in_timespan,
                          const RankingType &in_ranking_type = kOrdinal);

  string leaderboard_id;
  PlayerAccount player_account;
  LeaderboardCollection collection;
  PlayerAccountVector competitors;
  LeaderboardTimespan timespan;
  LeaderboardRange range;
  RankingType ranking_type;
};

typedef std::vector<LeaderboardQueryRequest> LeaderboardQueryRequestVector;


struct FUNAPI_DLL_VISIBILITY LeaderboardQueryResponse {
  LeaderboardQueryResponse();

  int64_t total_player_count;
  LeaderboardRecordVector records;
};

typedef std::vector<LeaderboardQueryResponse> LeaderboardQueryResponseVector;


struct FUNAPI_DLL_VISIBILITY ScoreSubmissionRequest {
  enum Type {
    // update player score if given score is highest
    kHighScore = 0,

    // increase player score
    kIncrement = 1,

    // decrease player score
    kDecrement = 2,

    // overwrite player score
    kOverwriting = 3,
  };

  ScoreSubmissionRequest(
      const string &in_leaderboard_id,
      const string &in_service_provider,
      const string &in_id,
      const double &in_score,
      const Type &in_type = kHighScore);

  // Appending my rank to ScoreSubmissionResponse
  ScoreSubmissionRequest(
      const string &in_leaderboard_id,
      const string &in_service_provider,
      const string &in_id,
      const double &in_score,
      const LeaderboardQueryRequest::RankingType &in_ranking_type,
      const LeaderboardTimespan &in_timespan,
      const Type &in_type = kHighScore);

  string leaderboard_id;
  PlayerAccount player_account;
  double score;
  LeaderboardQueryRequest::RankingType ranking_type;
  LeaderboardTimespan timespan;
  Type type;
};


struct FUNAPI_DLL_VISIBILITY ScoreSubmissionResponse {
  ScoreSubmissionResponse();

  LeaderboardScoreSubmissionResult result;
  double new_score;
  int64_t total_player_count;
  int64_t rank;
  double percentage;
};


struct FUNAPI_DLL_VISIBILITY ScoreDeletionRequest {
  ScoreDeletionRequest(const string &in_leaderboard_id,
                       const string &in_service_provider,
                       const string &in_id);

  string leaderboard_id;
  PlayerAccount player_account;
};

typedef std::vector<ScoreDeletionRequest> ScoreDeletionRequestVector;


struct FUNAPI_DLL_VISIBILITY ScoreDeletionResponse {
  enum Result {
    kNotExist = 0,
    kDeleted = 1
  };

  ScoreDeletionResponse();

  Result result;
};

typedef std::vector<ScoreDeletionResponse> ScoreDeletionResponseVector;


struct FUNAPI_DLL_VISIBILITY LeaderboardResetRequest {
  explicit LeaderboardResetRequest(const string &leaderboard_id);

  const string leaderboard_id;
};


struct FUNAPI_DLL_VISIBILITY LeaderboardResetResponse {
  LeaderboardResetResponse();

  bool already_reset;
  string reset_date_time;
};


struct FUNAPI_DLL_VISIBILITY LeaderboardResetSchedule {
  enum Period {
    kDay = 0,
    kWeek = 1,
    kMonth = 2
  };

  LeaderboardResetSchedule();

  LeaderboardResetSchedule(const string &leaderboard_id,
                           const Period &period,
                           const int64_t &interval,
                           const WallClock::Value &starts,
                           const WallClock::Value &ends);

  string leaderboard_id;
  Period period;
  int64_t interval;
  WallClock::Value starts;
  WallClock::Value ends;

  WallClock::Value latest_reset_date_time;
  WallClock::Value upcoming_date_time;
  WallClock::Duration upcoming_time;
  WallClock::Value next_date_time;
  WallClock::Duration next_time;
  bool expired;
};


typedef std::vector<LeaderboardResetSchedule> LeaderboardResetScheduleVector;


struct FUNAPI_DLL_VISIBILITY LeaderboardResetScheduleStatusQueryRequest {
  typedef LeaderboardResetSchedule::Period Period;

  LeaderboardResetScheduleStatusQueryRequest(
      const string &leaderboard_id,
      Period period,
      const WallClock::Value &latest_reset_date_time);

  const string leaderboard_id;
  const Period period;
  const string latest_reset_date_time;
};


struct FUNAPI_DLL_VISIBILITY LeaderboardResetScheduleStatusQueryResponse {
  enum Result {
    kOk = 0,
    kNotExist = 1
  };

  LeaderboardResetScheduleStatusQueryResponse();

  Result result;
  bool is_reset;
  WallClock::Value reset_date_time;
};


typedef function<void(const LeaderboardQueryRequest &request,
                      const LeaderboardQueryResponse &response,
                      const bool &error)> LeaderboardQueryResponseHandler;

typedef function<void(const LeaderboardQueryRequestVector &requests,
                      const LeaderboardQueryResponseVector &responses,
                      const bool &error)> LeaderboardQueryResponseHandler2;


typedef function<void(const ScoreSubmissionRequest &request,
                      const ScoreSubmissionResponse &response,
                      const bool &error)> ScoreSubmissionResponseHandler;


typedef function<void(const ScoreDeletionRequestVector &requests,
                      const ScoreDeletionResponseVector &responses,
                      const bool &error)> ScoreDeletionResponseHandler;


typedef function<void(const LeaderboardResetRequest &request,
                      const LeaderboardResetResponse &response,
                      const bool &error)> LeaderboardResetResponseHandler;

typedef function<
    void(const LeaderboardResetScheduleStatusQueryRequest &request,
         const LeaderboardResetScheduleStatusQueryResponse &response,
         const bool &error)> LeaderboardResetScheduleStatusQueryResponseHandler;


FUNAPI_DLL_VISIBILITY
void GetLeaderboard(const LeaderboardQueryRequest &request,
                    const LeaderboardQueryResponseHandler &handler,
                    const string &tag = "");

FUNAPI_DLL_VISIBILITY
void GetLeaderboard(const LeaderboardQueryRequestVector &requests,
                    const LeaderboardQueryResponseHandler2 &handler,
                    const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool GetLeaderboardSync(const LeaderboardQueryRequest &request,
                        LeaderboardQueryResponse *response,
                        const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool GetLeaderboardSync(const LeaderboardQueryRequestVector &requests,
                        LeaderboardQueryResponseVector *responses,
                        const string &tag = "");

FUNAPI_DLL_VISIBILITY
void SubmitScore(const ScoreSubmissionRequest &request,
                 const ScoreSubmissionResponseHandler &handler,
                 const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool SubmitScoreSync(const ScoreSubmissionRequest &request,
                     ScoreSubmissionResponse *response,
                     const string &tag = "");

FUNAPI_DLL_VISIBILITY
void DeleteScore(const ScoreDeletionRequestVector &requests,
                 const ScoreDeletionResponseHandler &handler,
                 const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool DeleteScoreSync(const ScoreDeletionRequestVector &requests,
                     ScoreDeletionResponseVector *responses,
                     const string &tag = "");

FUNAPI_DLL_VISIBILITY
void ResetLeaderboard(const LeaderboardResetRequest &request,
                      const LeaderboardResetResponseHandler &handler,
                      const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool GetLeaderboardResetSchedule(const string &leaderboard_id,
                                 const LeaderboardResetSchedule::Period &period,
                                 LeaderboardResetSchedule *reset_schedule,
                                 const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool GetLeaderboardResetSchedule(
    LeaderboardResetScheduleVector *reset_schedules,
    const string &tag = "");

FUNAPI_DLL_VISIBILITY
void GetLeaderboardResetScheduleStatusQuery(
    const LeaderboardResetScheduleStatusQueryRequest &request,
    const LeaderboardResetScheduleStatusQueryResponseHandler &handler,
    const string &tag = "");

FUNAPI_DLL_VISIBILITY
bool GetLeaderboardResetScheduleStatusQuerySync(
    const LeaderboardResetScheduleStatusQueryRequest &request,
    LeaderboardResetScheduleStatusQueryResponse *response,
    const string &tag = "");

}  // namespace fun

#endif  // INCLUDE_FUNAPI_SERVICE_LEADERBOARD_H_