rpc_error.h

/*
 * Copyright 2025 LiveKit
 *
 * 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.
 */
 
#pragma once
 
#include <cstdint>
#include <stdexcept>
#include <string>
 
#include "livekit/visibility.h"
 
namespace livekit {
 
namespace proto {
class RpcError;
}
 
class LIVEKIT_API RpcError : public std::runtime_error {
public:
  enum class ErrorCode : std::uint32_t {
    APPLICATION_ERROR = 1500,
    CONNECTION_TIMEOUT = 1501,
    RESPONSE_TIMEOUT = 1502,
    RECIPIENT_DISCONNECTED = 1503,
    RESPONSE_PAYLOAD_TOO_LARGE = 1504,
    SEND_FAILED = 1505,
 
    UNSUPPORTED_METHOD = 1400,
    RECIPIENT_NOT_FOUND = 1401,
    REQUEST_PAYLOAD_TOO_LARGE = 1402,
    UNSUPPORTED_SERVER = 1403,
    UNSUPPORTED_VERSION = 1404,
  };
 
  RpcError(std::uint32_t code, std::string message, std::string data = {});
 
  RpcError(ErrorCode code, std::string message, std::string data = {});
 
  std::uint32_t code() const noexcept;
 
  const std::string& message() const noexcept;
 
  const std::string& data() const noexcept;
 
  static RpcError builtIn(ErrorCode code, const std::string& data = {});
 
protected:
  // ----- Protected: only used by LocalParticipant (internal SDK code) -----
  proto::RpcError toProto() const;
  static RpcError fromProto(const proto::RpcError& err);
 
  friend class LocalParticipant;
  friend class FfiClient;
 
private:
  static const char* defaultMessageFor(ErrorCode code);
 
  std::uint32_t code_;
  std::string message_;
  std::string data_;
};
 
} // namespace livekit