flutter::JsonMethodCodec Class Reference

#include <json_method_codec.h>

Inheritance diagram for flutter::JsonMethodCodec:

Public Member Functions
	~JsonMethodCodec ()=default
	JsonMethodCodec (JsonMethodCodec const &)=delete
JsonMethodCodec &	operator= (JsonMethodCodec const &)=delete
Public Member Functions inherited from flutter::MethodCodec< rapidjson::Document >
	MethodCodec ()=default
	MethodCodec (MethodCodec< rapidjson::Document > const &)=delete
virtual	~MethodCodec ()=default
MethodCodec &	operator= (MethodCodec< rapidjson::Document > const &)=delete
std::unique_ptr< MethodCall< rapidjson::Document > >	DecodeMethodCall (const uint8_t *message, size_t message_size) const
std::unique_ptr< MethodCall< rapidjson::Document > >	DecodeMethodCall (const std::vector< uint8_t > &message) const
std::unique_ptr< std::vector< uint8_t > >	EncodeMethodCall (const MethodCall< rapidjson::Document > &method_call) const
std::unique_ptr< std::vector< uint8_t > >	EncodeSuccessEnvelope (const rapidjson::Document *result=nullptr) const
std::unique_ptr< std::vector< uint8_t > >	EncodeErrorEnvelope (const std::string &error_code, const std::string &error_message="", const rapidjson::Document *error_details=nullptr) const
bool	DecodeAndProcessResponseEnvelope (const uint8_t *response, size_t response_size, MethodResult< rapidjson::Document > *result) const

Static Public Member Functions
static const JsonMethodCodec &	GetInstance ()

Protected Member Functions
	JsonMethodCodec ()=default
std::unique_ptr< MethodCall< rapidjson::Document > >	DecodeMethodCallInternal (const uint8_t *message, const size_t message_size) const override
std::unique_ptr< std::vector< uint8_t > >	EncodeMethodCallInternal (const MethodCall< rapidjson::Document > &method_call) const override
std::unique_ptr< std::vector< uint8_t > >	EncodeSuccessEnvelopeInternal (const rapidjson::Document *result) const override
std::unique_ptr< std::vector< uint8_t > >	EncodeErrorEnvelopeInternal (const std::string &error_code, const std::string &error_message, const rapidjson::Document *error_details) const override
bool	DecodeAndProcessResponseEnvelopeInternal (const uint8_t *response, const size_t response_size, MethodResult< rapidjson::Document > *result) const override

Detailed Description

Definition at line 16 of file json_method_codec.h.

Constructor & Destructor Documentation

~JsonMethodCodec()

flutter::JsonMethodCodec::~JsonMethodCodec ( )

default

JsonMethodCodec() [1/2]

flutter::JsonMethodCodec::JsonMethodCodec ( JsonMethodCodec const &  )

delete

JsonMethodCodec() [2/2]

flutter::JsonMethodCodec::JsonMethodCodec ( )

protecteddefault

Member Function Documentation

DecodeAndProcessResponseEnvelopeInternal()

bool flutter::JsonMethodCodec::DecodeAndProcessResponseEnvelopeInternal ( const uint8_t *  response, const size_t  response_size, MethodResult< rapidjson::Document > *  result  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< rapidjson::Document >.

Definition at line 118 of file json_method_codec.cc.

                                                   {
  std::unique_ptr<rapidjson::Document> json_response =
      JsonMessageCodec::GetInstance().DecodeMessage(response, response_size);
  if (!json_response) {
    return false;
  }
  if (!json_response->IsArray()) {
    return false;
  }
  switch (json_response->Size()) {
    case 1: {
      std::unique_ptr<rapidjson::Document> value =
          ExtractElement(json_response.get(), &((*json_response)[0]));
      if (value->IsNull()) {
        result->Success();
      } else {
        result->Success(*value);
      }
      return true;
    }
    case 3: {
      std::string code = (*json_response)[0].GetString();
      std::string message = (*json_response)[1].GetString();
      std::unique_ptr<rapidjson::Document> details =
          ExtractElement(json_response.get(), &((*json_response)[2]));
      if (details->IsNull()) {
        result->Error(code, message);
      } else {
        result->Error(code, message, *details);
      }
      return true;
    }
    default:
      return false;
  }
}

References flutter::MessageCodec< T >::DecodeMessage(), flutter::MethodResult< T >::Error(), flutter::JsonMessageCodec::GetInstance(), and flutter::MethodResult< T >::Success().

DecodeMethodCallInternal()

std::unique_ptr< MethodCall< rapidjson::Document > > flutter::JsonMethodCodec::DecodeMethodCallInternal ( const uint8_t *  message, const size_t  message_size  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< rapidjson::Document >.

Definition at line 42 of file json_method_codec.cc.

                                                                     {
  std::unique_ptr<rapidjson::Document> json_message =
      JsonMessageCodec::GetInstance().DecodeMessage(message, message_size);
  if (!json_message) {
    return nullptr;
  }
 
  auto method_name_iter = json_message->FindMember(kMessageMethodKey);
  if (method_name_iter == json_message->MemberEnd()) {
    return nullptr;
  }
  if (!method_name_iter->value.IsString()) {
    return nullptr;
  }
  std::string method_name(method_name_iter->value.GetString());
  auto arguments_iter = json_message->FindMember(kMessageArgumentsKey);
  std::unique_ptr<rapidjson::Document> arguments;
  if (arguments_iter != json_message->MemberEnd()) {
    arguments = ExtractElement(json_message.get(), &(arguments_iter->value));
  }
  return std::make_unique<MethodCall<rapidjson::Document>>(
      method_name, std::move(arguments));
}

References flutter::MessageCodec< T >::DecodeMessage(), and flutter::JsonMessageCodec::GetInstance().

EncodeErrorEnvelopeInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::JsonMethodCodec::EncodeErrorEnvelopeInternal ( const std::string &  error_code, const std::string &  error_message, const rapidjson::Document *  error_details  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< rapidjson::Document >.

Definition at line 100 of file json_method_codec.cc.

                                                  {
  // NOLINTNEXTLINE(clang-analyzer-core.NullDereference)
  rapidjson::Document envelope(rapidjson::kArrayType);
  auto& allocator = envelope.GetAllocator();
  envelope.PushBack(rapidjson::Value(error_code, allocator), allocator);
  envelope.PushBack(rapidjson::Value(error_message, allocator), allocator);
  rapidjson::Value details_value;
  if (error_details) {
    details_value.CopyFrom(*error_details, allocator);
  }
  envelope.PushBack(details_value, allocator);
 
  return JsonMessageCodec::GetInstance().EncodeMessage(envelope);
}

References flutter::MessageCodec< T >::EncodeMessage(), and flutter::JsonMessageCodec::GetInstance().

EncodeMethodCallInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::JsonMethodCodec::EncodeMethodCallInternal ( const MethodCall< rapidjson::Document > &  method_call ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< rapidjson::Document >.

Definition at line 67 of file json_method_codec.cc.

                                                            {
  // TODO(stuartmorgan): Consider revisiting the codec APIs to avoid the need
  // to copy everything when doing encoding (e.g., by having a version that
  // takes owership of the object to encode, so that it can be moved instead).
  rapidjson::Document message(rapidjson::kObjectType);
  auto& allocator = message.GetAllocator();
  rapidjson::Value name(method_call.method_name(), allocator);
  rapidjson::Value arguments;
  if (method_call.arguments()) {
    arguments.CopyFrom(*method_call.arguments(), allocator);
  }
  message.AddMember(kMessageMethodKey, name, allocator);
  message.AddMember(kMessageArgumentsKey, arguments, allocator);
 
  return JsonMessageCodec::GetInstance().EncodeMessage(message);
}

References flutter::MethodCall< T >::arguments(), flutter::MessageCodec< T >::EncodeMessage(), flutter::JsonMessageCodec::GetInstance(), and flutter::MethodCall< T >::method_name().

EncodeSuccessEnvelopeInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::JsonMethodCodec::EncodeSuccessEnvelopeInternal ( const rapidjson::Document *  result ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< rapidjson::Document >.

Definition at line 86 of file json_method_codec.cc.

                                           {
  rapidjson::Document envelope;
  envelope.SetArray();
  rapidjson::Value result_value;
  if (result) {
    result_value.CopyFrom(*result, envelope.GetAllocator());
  }
  envelope.PushBack(result_value, envelope.GetAllocator());
 
  return JsonMessageCodec::GetInstance().EncodeMessage(envelope);
}

References flutter::MessageCodec< T >::EncodeMessage(), and flutter::JsonMessageCodec::GetInstance().

GetInstance()

const JsonMethodCodec & flutter::JsonMethodCodec::GetInstance ( )

static

Definition at line 36 of file json_method_codec.cc.

                                                    {
  static JsonMethodCodec sInstance;
  return sInstance;
}

Referenced by flutter::TEST().

operator=()

JsonMethodCodec& flutter::JsonMethodCodec::operator= ( JsonMethodCodec const &  )

delete

---

The documentation for this class was generated from the following files:

• shell/platform/common/json_method_codec.h
• shell/platform/common/json_method_codec.cc