FlutterStandardMethodCodec Class Reference

#include <FlutterCodecs.h>

Inheritance diagram for FlutterStandardMethodCodec:

Instance Methods
(instancetype)	- initWithReaderWriter: [implementation]
(NSData *)	- encodeMethodCall: [implementation]
(NSData *)	- encodeSuccessEnvelope: [implementation]
(NSData *)	- encodeErrorEnvelope: [implementation]
(FlutterMethodCall *)	- decodeMethodCall: [implementation]
(id)	- decodeEnvelope: [implementation]

Class Methods
(instancetype)	+ codecWithReaderWriter:
(instancetype)	+ sharedInstance [implementation]

Detailed Description

A FlutterMethodCodec using the Flutter standard binary encoding.

This codec is guaranteed to be compatible with the corresponding StandardMethodCodec on the Dart side. These parts of the Flutter SDK are evolved synchronously.

Values supported as method arguments and result payloads are those supported by FlutterStandardMessageCodec.

Definition at line 469 of file FlutterCodecs.h.

Method Documentation

codecWithReaderWriter:

+ (instancetype) codecWithReaderWriter:

(FlutterStandardReaderWriter*)

readerWriter

Create a FlutterStandardMethodCodec who will read and write to readerWriter.

Definition at line 8 of file FlutterStandardCodec.mm.

                                     :(FlutterStandardReaderWriter*)readerWriter {
  return [[FlutterStandardMethodCodec alloc] initWithReaderWriter:readerWriter];
}

decodeEnvelope:

- (id) decodeEnvelope: (NSData*)  envelope

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                    :(NSData*)envelope {
  FlutterStandardReader* reader = [_readerWriter readerWithData:envelope];
  UInt8 flag = [reader readByte];
  NSAssert(flag <= 1, @"Corrupted standard envelope");
  id result;
  switch (flag) {
    case 0: {
      result = [reader readValue];
      NSAssert(![reader hasMore], @"Corrupted standard envelope");
    } break;
    case 1: {
      id code = [reader readValue];
      id message = [reader readValue];
      id details = [reader readValue];
      NSAssert(![reader hasMore], @"Corrupted standard envelope");
      NSAssert([code isKindOfClass:[NSString class]], @"Invalid standard envelope");
      NSAssert(message == nil || [message isKindOfClass:[NSString class]],
               @"Invalid standard envelope");
      result = [FlutterError errorWithCode:code message:message details:details];
    } break;
  }
  return result;
}

decodeMethodCall:

- (FlutterMethodCall *) decodeMethodCall: (NSData*)  message

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                                      :(NSData*)message {
  FlutterStandardReader* reader = [_readerWriter readerWithData:message];
  id value1 = [reader readValue];
  id value2 = [reader readValue];
  NSAssert(![reader hasMore], @"Corrupted standard method call");
  NSAssert([value1 isKindOfClass:[NSString class]], @"Corrupted standard method call");
  return [FlutterMethodCall methodCallWithMethodName:value1 arguments:value2];
}

encodeErrorEnvelope:

- (NSData *) encodeErrorEnvelope: (FlutterError*)  error

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                              :(FlutterError*)error {
  NSMutableData* data = [NSMutableData dataWithCapacity:32];
  FlutterStandardWriter* writer = [_readerWriter writerWithData:data];
  [writer writeByte:1];
  [writer writeValue:error.code];
  [writer writeValue:error.message];
  [writer writeValue:error.details];
  return data;
}

encodeMethodCall:

- (NSData *) encodeMethodCall: (FlutterMethodCall*)  call

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                           :(FlutterMethodCall*)call {
  NSMutableData* data = [NSMutableData dataWithCapacity:32];
  FlutterStandardWriter* writer = [_readerWriter writerWithData:data];
  [writer writeValue:call.method];
  [writer writeValue:call.arguments];
  return data;
}

encodeSuccessEnvelope:

- (NSData *) encodeSuccessEnvelope: (id)  result

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                                :(id)result {
  NSMutableData* data = [NSMutableData dataWithCapacity:32];
  FlutterStandardWriter* writer = [_readerWriter writerWithData:data];
  [writer writeByte:0];
  [writer writeValue:result];
  return data;
}

initWithReaderWriter:

- (instancetype) initWithReaderWriter: (FlutterStandardReaderWriter*)  readerWriter

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                                    :(FlutterStandardReaderWriter*)readerWriter {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
  _readerWriter = readerWriter;
  return self;
}

sharedInstance

+ (instancetype) sharedInstance

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                               {
  static id _sharedInstance = nil;
  if (!_sharedInstance) {
    FlutterStandardReaderWriter* readerWriter = [[FlutterStandardReaderWriter alloc] init];
    _sharedInstance = [[FlutterStandardMethodCodec alloc] initWithReaderWriter:readerWriter];
  }
  return _sharedInstance;
}

---

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

• shell/platform/darwin/common/framework/Headers/FlutterCodecs.h
• shell/platform/darwin/common/framework/Source/FlutterStandardCodec.mm