flutter::StandardMethodCodec Class Reference

#include <standard_method_codec.h>

Inheritance diagram for flutter::StandardMethodCodec:

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

Static Public Member Functions
static const StandardMethodCodec &	GetInstance (const StandardCodecSerializer *serializer=nullptr)

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

Detailed Description

Definition at line 18 of file standard_method_codec.h.

Constructor & Destructor Documentation

~StandardMethodCodec()

flutter::StandardMethodCodec::~StandardMethodCodec ( )

default

StandardMethodCodec()

flutter::StandardMethodCodec::StandardMethodCodec ( StandardMethodCodec const &  )

delete

Referenced by GetInstance().

Member Function Documentation

DecodeAndProcessResponseEnvelopeInternal()

bool flutter::StandardMethodCodec::DecodeAndProcessResponseEnvelopeInternal ( const uint8_t *  response, size_t  response_size, MethodResult< EncodableValue > *  result  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< EncodableValue >.

Definition at line 434 of file standard_codec.cc.

                                                {
  ByteBufferStreamReader stream(response, response_size);
  uint8_t flag = stream.ReadByte();
  switch (flag) {
    case 0: {
      EncodableValue value = serializer_->ReadValue(&stream);
      if (value.IsNull()) {
        result->Success();
      } else {
        result->Success(value);
      }
      return true;
    }
    case 1: {
      EncodableValue code = serializer_->ReadValue(&stream);
      EncodableValue message = serializer_->ReadValue(&stream);
      EncodableValue details = serializer_->ReadValue(&stream);
      const std::string& message_string =
          message.IsNull() ? "" : std::get<std::string>(message);
      if (details.IsNull()) {
        result->Error(std::get<std::string>(code), message_string);
      } else {
        result->Error(std::get<std::string>(code), message_string, details);
      }
      return true;
    }
    default:
      return false;
  }
}

References flutter::MethodResult< T >::Error(), flag, flutter::EncodableValue::IsNull(), flutter::ByteBufferStreamReader::ReadByte(), flutter::StandardCodecSerializer::ReadValue(), flutter::MethodResult< T >::Success(), and value.

DecodeMethodCallInternal()

std::unique_ptr< MethodCall< EncodableValue > > flutter::StandardMethodCodec::DecodeMethodCallInternal ( const uint8_t *  message, size_t  message_size  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< EncodableValue >.

Definition at line 368 of file standard_codec.cc.

                                                                         {
  ByteBufferStreamReader stream(message, message_size);
  EncodableValue method_name_value = serializer_->ReadValue(&stream);
  const auto* method_name = std::get_if<std::string>(&method_name_value);
  if (!method_name) {
    std::cerr << "Invalid method call; method name is not a string."
              << std::endl;
    return nullptr;
  }
  auto arguments =
      std::make_unique<EncodableValue>(serializer_->ReadValue(&stream));
  return std::make_unique<MethodCall<EncodableValue>>(*method_name,
                                                      std::move(arguments));
}

References flutter::StandardCodecSerializer::ReadValue().

EncodeErrorEnvelopeInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::StandardMethodCodec::EncodeErrorEnvelopeInternal ( const std::string &  error_code, const std::string &  error_message, const EncodableValue *  error_details  ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< EncodableValue >.

Definition at line 413 of file standard_codec.cc.

                                               {
  auto encoded = std::make_unique<std::vector<uint8_t>>();
  ByteBufferStreamWriter stream(encoded.get());
  stream.WriteByte(1);
  serializer_->WriteValue(EncodableValue(error_code), &stream);
  if (error_message.empty()) {
    serializer_->WriteValue(EncodableValue(), &stream);
  } else {
    serializer_->WriteValue(EncodableValue(error_message), &stream);
  }
  if (error_details) {
    serializer_->WriteValue(*error_details, &stream);
  } else {
    serializer_->WriteValue(EncodableValue(), &stream);
  }
  return encoded;
}

References flutter::StandardCodecSerializer::WriteValue().

EncodeMethodCallInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::StandardMethodCodec::EncodeMethodCallInternal ( const MethodCall< EncodableValue > &  method_call ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< EncodableValue >.

Definition at line 385 of file standard_codec.cc.

                                                         {
  auto encoded = std::make_unique<std::vector<uint8_t>>();
  ByteBufferStreamWriter stream(encoded.get());
  serializer_->WriteValue(EncodableValue(method_call.method_name()), &stream);
  if (method_call.arguments()) {
    serializer_->WriteValue(*method_call.arguments(), &stream);
  } else {
    serializer_->WriteValue(EncodableValue(), &stream);
  }
  return encoded;
}

References method_call, and flutter::StandardCodecSerializer::WriteValue().

EncodeSuccessEnvelopeInternal()

std::unique_ptr< std::vector< uint8_t > > flutter::StandardMethodCodec::EncodeSuccessEnvelopeInternal ( const EncodableValue *  result ) const

overrideprotectedvirtual

Implements flutter::MethodCodec< EncodableValue >.

Definition at line 399 of file standard_codec.cc.

                                        {
  auto encoded = std::make_unique<std::vector<uint8_t>>();
  ByteBufferStreamWriter stream(encoded.get());
  stream.WriteByte(0);
  if (result) {
    serializer_->WriteValue(*result, &stream);
  } else {
    serializer_->WriteValue(EncodableValue(), &stream);
  }
  return encoded;
}

References flutter::StandardCodecSerializer::WriteValue().

GetInstance()

const StandardMethodCodec & flutter::StandardMethodCodec::GetInstance ( const StandardCodecSerializer *  serializer = nullptr )

static

Definition at line 341 of file standard_codec.cc.

                                               {
  if (!serializer) {
    serializer = &StandardCodecSerializer::GetInstance();
  }
  static auto* sInstances = new std::map<const StandardCodecSerializer*,
                                         std::unique_ptr<StandardMethodCodec>>;
  auto it = sInstances->find(serializer);
  if (it == sInstances->end()) {
    // Uses new due to private constructor (to prevent API clients from
    // accidentally passing temporary codec instances to channels).
    // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
    auto emplace_result = sInstances->emplace(
        serializer, std::unique_ptr<StandardMethodCodec>(
                        new StandardMethodCodec(serializer)));
    it = emplace_result.first;
  }
  return *(it->second);
}

References flutter::StandardCodecSerializer::GetInstance(), and StandardMethodCodec().

Referenced by flutter::internal::ResizeChannel(), flutter::internal::SetChannelWarnsOnOverflow(), and flutter::TEST().

operator=()

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

delete

---

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

• shell/platform/common/client_wrapper/include/flutter/standard_method_codec.h
• shell/platform/common/client_wrapper/standard_codec.cc