FlutterChannels.mm File Reference

import "flutter/shell/platform/darwin/common/framework/Headers/FlutterChannels.h"

Go to the source code of this file.

Functions
static void	ResizeChannelBuffer (NSObject< FlutterBinaryMessenger > *binaryMessenger, NSString *channel, NSInteger newSize)
static void	SetWarnsOnOverflow (NSObject< FlutterBinaryMessenger > *binaryMessenger, NSString *channel, BOOL warns)
static FlutterBinaryMessengerConnection	SetMessageHandler (NSObject< FlutterBinaryMessenger > *messenger, NSString *name, FlutterBinaryMessageHandler handler, NSObject< FlutterTaskQueue > *taskQueue)

Variables
static FLUTTER_ASSERT_ARC NSString *const	kFlutterChannelBuffersChannel = @"@"dev.flutter/channel-buffers"
static NSString *const	kResizeMethod = @"@"resize"
static NSString *const	kOverflowMethod = @"@"overflow"
NSString *	_name
NSObject< FlutterMessageCodec > *	_codec
FlutterBinaryMessengerConnection	_connection
NSObject< FlutterTaskQueue > *	_taskQueue

Function Documentation

ResizeChannelBuffer()

static void ResizeChannelBuffer ( NSObject< FlutterBinaryMessenger > *  binaryMessenger, NSString *  channel, NSInteger  newSize  )

static

Definition at line 15 of file FlutterChannels.mm.

                                                   {
  NSCAssert(newSize >= 0, @"Channel buffer size must be non-negative");
  // Cast newSize to int because the deserialization logic handles only 32 bits values,
  // see
  // https://github.com/flutter/engine/blob/93e8901490e78c7ba7e319cce4470d9c6478c6dc/lib/ui/channel_buffers.dart#L495.
  NSArray* args = @[ channel, @(static_cast<int>(newSize)) ];
  FlutterMethodCall* resizeMethodCall = [FlutterMethodCall methodCallWithMethodName:kResizeMethod
                                                                          arguments:args];
  NSObject<FlutterMethodCodec>* codec = [FlutterStandardMethodCodec sharedInstance];
  NSData* message = [codec encodeMethodCall:resizeMethodCall];
  [binaryMessenger sendOnChannel:kFlutterChannelBuffersChannel message:message];
}

References args, channel, kFlutterChannelBuffersChannel, kResizeMethod, and message.

SetMessageHandler()

static FlutterBinaryMessengerConnection SetMessageHandler ( NSObject< FlutterBinaryMessenger > *  messenger, NSString *  name, FlutterBinaryMessageHandler  handler, NSObject< FlutterTaskQueue > *  taskQueue  )

static

Definition at line 50 of file FlutterChannels.mm.

                                           {
  if (taskQueue) {
    NSCAssert([messenger respondsToSelector:@selector(setMessageHandlerOnChannel:
                                                            binaryMessageHandler:taskQueue:)],
              @"");
    return [messenger setMessageHandlerOnChannel:name
                            binaryMessageHandler:handler
                                       taskQueue:taskQueue];
  } else {
    return [messenger setMessageHandlerOnChannel:name binaryMessageHandler:handler];
  }
}

References handler, and name.

SetWarnsOnOverflow()

static void SetWarnsOnOverflow ( NSObject< FlutterBinaryMessenger > *  binaryMessenger, NSString *  channel, BOOL  warns  )

static

Defines whether a channel should show warning messages when discarding messages due to overflow.

Parameters

binaryMessenger	The binary messenger.
channel	The channel name.
warns	When false, the channel is expected to overflow and warning messages will not be shown.

Definition at line 39 of file FlutterChannels.mm.

                                           {
  FlutterMethodCall* overflowMethodCall =
      [FlutterMethodCall methodCallWithMethodName:kOverflowMethod
                                        arguments:@[ channel, @(!warns) ]];
  NSObject<FlutterMethodCodec>* codec = [FlutterStandardMethodCodec sharedInstance];
  NSData* message = [codec encodeMethodCall:overflowMethodCall];
  [binaryMessenger sendOnChannel:kFlutterChannelBuffersChannel message:message];
}

References channel, kFlutterChannelBuffersChannel, kOverflowMethod, and message.

Variable Documentation

_codec

NSObject<FlutterMessageCodec>* _codec

Definition at line 71 of file FlutterChannels.mm.

_connection

FlutterBinaryMessengerConnection _connection

Definition at line 72 of file FlutterChannels.mm.

_name

NSString* _name

Initial value:

{
  NSObject<FlutterBinaryMessenger>* _messenger

Definition at line 70 of file FlutterChannels.mm.

_taskQueue

NSObject<FlutterTaskQueue>* _taskQueue

Definition at line 73 of file FlutterChannels.mm.

kFlutterChannelBuffersChannel

FLUTTER_ASSERT_ARC NSString* const kFlutterChannelBuffersChannel = @"@"dev.flutter/channel-buffers"

static

Definition at line 11 of file FlutterChannels.mm.

Referenced by ResizeChannelBuffer(), and SetWarnsOnOverflow().

kOverflowMethod

NSString* const kOverflowMethod = @"@"overflow"

static

Definition at line 13 of file FlutterChannels.mm.

Referenced by flutter::internal::SetChannelWarnsOnOverflow(), and SetWarnsOnOverflow().

kResizeMethod

NSString* const kResizeMethod = @"@"resize"

static

Definition at line 12 of file FlutterChannels.mm.

Referenced by flutter::internal::ResizeChannel(), and ResizeChannelBuffer().