FlutterStandardMessageCodec Class Reference

#include <FlutterCodecs.h>

Inheritance diagram for FlutterStandardMessageCodec:

Instance Methods
(instancetype)	- initWithReaderWriter: [implementation]
(NSData *)	- encode: [implementation]
(id)	- decode: [implementation]
Instance Methods inherited from <FlutterMessageCodec>
(NSData *_Nullable)	- encode:
(id _Nullable)	- decode:

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

Detailed Description

A FlutterMessageCodec using the Flutter standard binary encoding.

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

Supported messages are acyclic values of these forms:

• nil or NSNull
• NSNumber (including their representation of Boolean values)
• NSString
• FlutterStandardTypedData
• NSArray of supported values
• NSDictionary with supported keys and values

On the Dart side, these values are represented as follows:

• nil or NSNull: null
• NSNumber: bool, int, or double, depending on the contained value.
• NSString: String
• FlutterStandardTypedData: Uint8List, Int32List, Int64List, or Float64List
• NSArray: List
• NSDictionary: Map

Definition at line 209 of file FlutterCodecs.h.

Method Documentation

codecWithReaderWriter:

+ (instancetype) codecWithReaderWriter:

(FlutterStandardReaderWriter*)

readerWriter

Create a FlutterStandardMessageCodec who will read and write to readerWriter.

Definition at line 8 of file FlutterStandardCodec.mm.

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

decode:

- (id) decode: (NSData*)  message

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

            :(NSData*)message {
  if ([message length] == 0) {
    return nil;
  }
  FlutterStandardReader* reader = [_readerWriter readerWithData:message];
  id value = [reader readValue];
  NSAssert(![reader hasMore], @"Corrupted standard message");
  return value;
}

encode:

- (NSData *) encode: (id)  message

implementation

Definition at line 8 of file FlutterStandardCodec.mm.

                 :(id)message {
  if (message == nil) {
    return nil;
  }
  NSMutableData* data = [NSMutableData dataWithCapacity:32];
  FlutterStandardWriter* writer = [_readerWriter writerWithData:data];
  [writer writeValue:message];
  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

Returns a shared instance of this FlutterMessageCodec.

Reimplemented from <FlutterMessageCodec>.

Definition at line 8 of file FlutterStandardCodec.mm.

                               {
  static id _sharedInstance = nil;
  if (!_sharedInstance) {
    FlutterStandardReaderWriter* readerWriter = [[FlutterStandardReaderWriter alloc] init];
    _sharedInstance = [[FlutterStandardMessageCodec 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