feat: Implement gRPC ROM service for remote manipulation
- Added `RomServiceImpl` class to facilitate remote ROM operations, including reading/writing ROM data, managing versions, and submitting proposals. - Integrated gRPC support for real-time collaboration and remote access to ROM functionalities. - Updated `README.md` to document the new gRPC ROM service and its capabilities. - Enhanced CMake configuration to include new source files for the gRPC implementation and related services.
This commit is contained in:
170
src/app/net/rom_service_impl.h
Normal file
170
src/app/net/rom_service_impl.h
Normal file
@@ -0,0 +1,170 @@
|
||||
#ifndef YAZE_APP_NET_ROM_SERVICE_IMPL_H_
|
||||
#define YAZE_APP_NET_ROM_SERVICE_IMPL_H_
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
|
||||
#include "absl/status/status.h"
|
||||
#include "absl/status/statusor.h"
|
||||
|
||||
#ifdef YAZE_WITH_GRPC
|
||||
#include <grpcpp/grpcpp.h>
|
||||
#include "protos/rom_service.grpc.pb.h"
|
||||
#endif
|
||||
|
||||
#include "app/rom.h"
|
||||
#include "app/net/rom_version_manager.h"
|
||||
|
||||
namespace yaze {
|
||||
namespace app {
|
||||
namespace net {
|
||||
|
||||
#ifdef YAZE_WITH_GRPC
|
||||
|
||||
/**
|
||||
* @brief gRPC service implementation for remote ROM manipulation
|
||||
*
|
||||
* Enables remote clients (like z3ed CLI) to:
|
||||
* - Read/write ROM data
|
||||
* - Submit proposals for collaborative editing
|
||||
* - Manage ROM versions and snapshots
|
||||
* - Query ROM structures (overworld, dungeons, sprites)
|
||||
*
|
||||
* Thread-safe and designed for concurrent access.
|
||||
*/
|
||||
class RomServiceImpl final : public proto::RomService::Service {
|
||||
public:
|
||||
/**
|
||||
* @brief Configuration for the ROM service
|
||||
*/
|
||||
struct Config {
|
||||
bool require_approval_for_writes = true; // Submit writes as proposals
|
||||
bool enable_version_management = true; // Auto-snapshot before changes
|
||||
int max_read_size_bytes = 1024 * 1024; // 1MB max per read
|
||||
bool allow_raw_rom_access = true; // Allow direct byte access
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Construct ROM service
|
||||
* @param rom Pointer to ROM instance (not owned)
|
||||
* @param version_mgr Pointer to version manager (not owned, optional)
|
||||
* @param approval_mgr Pointer to approval manager (not owned, optional)
|
||||
*/
|
||||
RomServiceImpl(Rom* rom,
|
||||
RomVersionManager* version_mgr = nullptr,
|
||||
ProposalApprovalManager* approval_mgr = nullptr);
|
||||
|
||||
~RomServiceImpl() override = default;
|
||||
|
||||
// Initialize with configuration
|
||||
void SetConfig(const Config& config) { config_ = config; }
|
||||
|
||||
// =========================================================================
|
||||
// Basic ROM Operations
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status ReadBytes(
|
||||
grpc::ServerContext* context,
|
||||
const proto::ReadBytesRequest* request,
|
||||
proto::ReadBytesResponse* response) override;
|
||||
|
||||
grpc::Status WriteBytes(
|
||||
grpc::ServerContext* context,
|
||||
const proto::WriteBytesRequest* request,
|
||||
proto::WriteBytesResponse* response) override;
|
||||
|
||||
grpc::Status GetRomInfo(
|
||||
grpc::ServerContext* context,
|
||||
const proto::GetRomInfoRequest* request,
|
||||
proto::GetRomInfoResponse* response) override;
|
||||
|
||||
// =========================================================================
|
||||
// Overworld Operations
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status ReadOverworldMap(
|
||||
grpc::ServerContext* context,
|
||||
const proto::ReadOverworldMapRequest* request,
|
||||
proto::ReadOverworldMapResponse* response) override;
|
||||
|
||||
grpc::Status WriteOverworldTile(
|
||||
grpc::ServerContext* context,
|
||||
const proto::WriteOverworldTileRequest* request,
|
||||
proto::WriteOverworldTileResponse* response) override;
|
||||
|
||||
// =========================================================================
|
||||
// Dungeon Operations
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status ReadDungeonRoom(
|
||||
grpc::ServerContext* context,
|
||||
const proto::ReadDungeonRoomRequest* request,
|
||||
proto::ReadDungeonRoomResponse* response) override;
|
||||
|
||||
grpc::Status WriteDungeonTile(
|
||||
grpc::ServerContext* context,
|
||||
const proto::WriteDungeonTileRequest* request,
|
||||
proto::WriteDungeonTileResponse* response) override;
|
||||
|
||||
// =========================================================================
|
||||
// Sprite Operations
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status ReadSprite(
|
||||
grpc::ServerContext* context,
|
||||
const proto::ReadSpriteRequest* request,
|
||||
proto::ReadSpriteResponse* response) override;
|
||||
|
||||
// =========================================================================
|
||||
// Proposal System
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status SubmitRomProposal(
|
||||
grpc::ServerContext* context,
|
||||
const proto::SubmitRomProposalRequest* request,
|
||||
proto::SubmitRomProposalResponse* response) override;
|
||||
|
||||
grpc::Status GetProposalStatus(
|
||||
grpc::ServerContext* context,
|
||||
const proto::GetProposalStatusRequest* request,
|
||||
proto::GetProposalStatusResponse* response) override;
|
||||
|
||||
// =========================================================================
|
||||
// Version Management
|
||||
// =========================================================================
|
||||
|
||||
grpc::Status CreateSnapshot(
|
||||
grpc::ServerContext* context,
|
||||
const proto::CreateSnapshotRequest* request,
|
||||
proto::CreateSnapshotResponse* response) override;
|
||||
|
||||
grpc::Status RestoreSnapshot(
|
||||
grpc::ServerContext* context,
|
||||
const proto::RestoreSnapshotRequest* request,
|
||||
proto::RestoreSnapshotResponse* response) override;
|
||||
|
||||
grpc::Status ListSnapshots(
|
||||
grpc::ServerContext* context,
|
||||
const proto::ListSnapshotsRequest* request,
|
||||
proto::ListSnapshotsResponse* response) override;
|
||||
|
||||
private:
|
||||
Config config_;
|
||||
Rom* rom_; // Not owned
|
||||
RomVersionManager* version_mgr_; // Not owned, may be null
|
||||
ProposalApprovalManager* approval_mgr_; // Not owned, may be null
|
||||
|
||||
// Helper to check if ROM is loaded
|
||||
grpc::Status ValidateRomLoaded();
|
||||
|
||||
// Helper to create snapshot before write operations
|
||||
absl::Status MaybeCreateSnapshot(const std::string& description);
|
||||
};
|
||||
|
||||
#endif // YAZE_WITH_GRPC
|
||||
|
||||
} // namespace net
|
||||
} // namespace app
|
||||
} // namespace yaze
|
||||
|
||||
#endif // YAZE_APP_NET_ROM_SERVICE_IMPL_H_
|
||||
Reference in New Issue
Block a user