matchmaking.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_MATCHMAKING_H_
#define INCLUDE_FUNAPI_SERVICE_MATCHMAKING_H_

#include <funapi/common/json.h>
#include <funapi/distribution/rpc.h>
#include <funapi/framework/component.h>
#include <funapi/time/wall_clock.h>
#include <funapi/types.h>


namespace fun {

class FUNAPI_DLL_VISIBILITY MatchmakingClient {
 public:
  typedef Uuid MatchId;
  typedef int64_t Type;

  struct FUNAPI_DLL_VISIBILITY Player {
    string id;
    Json context;
    Rpc::PeerId location;
  };

  struct FUNAPI_DLL_VISIBILITY Match {
    explicit Match(Type _type);
    explicit Match(const MatchId &_match_id, Type _type);

    const MatchId match_id;
    const Type type;

    std::vector<Player> players;
    Json context;
  };

  enum MatchResult {
    kMRSuccess = 0,
    kMRAlreadyRequested,
    kMRTimeout,
    kMRError = 1000
  };

  enum CancelResult {
    kCRSuccess = 0,
    kCRNoRequest,
    kCRError = 1000
  };

  typedef function<void(const string & /*player_id*/,
                        const Match & /*match*/,
                        MatchResult /*result*/)> MatchCallback;

  typedef function<void(const string & /*player_id*/,
                        const MatchId & /*match_id*/,
                        const string & /*player_id_joined*/,
                        const string & /*player_id_left*/)> ProgressCallback;

  typedef function<void(const string & /*player_id*/,
                        const Match & /*match*/,
                        const string & /*player_id_joined*/,
                        const string & /*player_id_left*/)> ProgressCallback2;

  typedef function<void(const string & /*player_id*/,
                        CancelResult /*result*/)> CancelCallback;


  enum TargetServerSelection {
    kRandom = 0,
    kMostNumberOfPlayers,
    kLeastNumberOfPlayers
  };

  struct FUNAPI_DLL_VISIBILITY MatchmakingServerInfo {
    Rpc::PeerId peer_id;
    size_t player_count;
    bool want_more_players;
  };

  typedef std::vector<MatchmakingServerInfo> MatchmakingServerInfoVector;

  static const WallClock::Duration kNullTimeout;
  static const ProgressCallback kNullProgressCallback;
  static const ProgressCallback2 kNullProgressCallback2;

  static MatchmakingServerInfoVector GetMatchmakingServerInfo();

  static void StartMatchmaking(const Type &type, const string &player_id,
      const Json &player_context, const MatchCallback &match_callback,
      const TargetServerSelection &target_server = kRandom,
      const ProgressCallback &progress_callback = kNullProgressCallback,
      const WallClock::Duration &timeout = kNullTimeout) ASSERT_NO_ROLLBACK;

  static void StartMatchmaking(const Type &type, const string &player_id,
      const Json &player_context, const MatchCallback &match_callback,
      const Rpc::PeerId &target_server,
      const ProgressCallback &progress_callback = kNullProgressCallback,
      const WallClock::Duration &timeout = kNullTimeout) ASSERT_NO_ROLLBACK;

  static void StartMatchmaking2(const Type &type, const string &player_id,
      const Json &player_context, const MatchCallback &match_callback,
      const TargetServerSelection &target_server = kRandom,
      const ProgressCallback2 &progress_callback2 = kNullProgressCallback2,
      const WallClock::Duration &timeout = kNullTimeout) ASSERT_NO_ROLLBACK;

  static void StartMatchmaking2(const Type &type, const string &player_id,
      const Json &player_context, const MatchCallback &match_callback,
      const Rpc::PeerId &target_server,
      const ProgressCallback2 &progress_callback2 = kNullProgressCallback2,
      const WallClock::Duration &timeout = kNullTimeout) ASSERT_NO_ROLLBACK;

  static void CancelMatchmaking(const Type &type, const string &player_id,
      const CancelCallback &cancel_callback) ASSERT_NO_ROLLBACK;

  static void UpdateMatchPlayerContext(const Type &type,
      const string &player_id, const Json &new_context) ASSERT_NO_ROLLBACK;
};


class FUNAPI_DLL_VISIBILITY MatchmakingServer {
 public:
  typedef MatchmakingClient::MatchId MatchId;
  typedef MatchmakingClient::Type Type;
  typedef MatchmakingClient::Player Player;
  typedef MatchmakingClient::Match Match;
  typedef MatchmakingClient::MatchResult MatchResult;
  typedef MatchmakingClient::CancelResult CancelResult;

  enum MatchState {
    kMatchNeedMorePlayer = 0,
    kMatchComplete
  };

  typedef function<bool(const Player & /*player*/,
                        const Match & /*match*/)> MatchChecker;

  typedef function<MatchState(const Match & /*match*/)> CompletionChecker;

  typedef function<void(const Player & /*player*/,
                        Match * /*match*/)> JoinCallback;

  typedef function<void(const Player & /*player*/,
                        Match * /*match*/)> LeaveCallback;

  static void Start(const MatchChecker &match_checker,
                    const CompletionChecker &completion_checker,
                    const JoinCallback &join_cb, const LeaveCallback &leave_cb);
};

}  // namespace fun

#endif  // INCLUDE_FUNAPI_SERVICE_MATCHMAKING_H_