fl_method_call.cc File Reference

#include "flutter/shell/platform/linux/public/flutter_linux/fl_method_call.h"
#include "flutter/shell/platform/linux/fl_method_call_private.h"
#include "flutter/shell/platform/linux/fl_method_channel_private.h"
#include <gmodule.h>

Go to the source code of this file.

Classes
struct	_FlMethodCall

Functions
static void	fl_method_call_dispose (GObject *object)
static void	fl_method_call_class_init (FlMethodCallClass *klass)
static void	fl_method_call_init (FlMethodCall *self)
FlMethodCall *	fl_method_call_new (const gchar *name, FlValue *args, FlMethodChannel *channel, FlBinaryMessengerResponseHandle *response_handle)
G_MODULE_EXPORT const gchar *	fl_method_call_get_name (FlMethodCall *self)
G_MODULE_EXPORT FlValue *	fl_method_call_get_args (FlMethodCall *self)
G_MODULE_EXPORT gboolean	fl_method_call_respond (FlMethodCall *self, FlMethodResponse *response, GError **error)
G_MODULE_EXPORT gboolean	fl_method_call_respond_success (FlMethodCall *self, FlValue *result, GError **error)
G_MODULE_EXPORT gboolean	fl_method_call_respond_error (FlMethodCall *self, const gchar *code, const gchar *message, FlValue *details, GError **error)
G_MODULE_EXPORT gboolean	fl_method_call_respond_not_implemented (FlMethodCall *self, GError **error)

Function Documentation

fl_method_call_class_init()

static void fl_method_call_class_init ( FlMethodCallClass *  klass )

static

Definition at line 38 of file fl_method_call.cc.

                                                                {
  G_OBJECT_CLASS(klass)->dispose = fl_method_call_dispose;
}

fl_method_call_dispose()

static void fl_method_call_dispose ( GObject *  object )

static

Definition at line 27 of file fl_method_call.cc.

                                                    {
  FlMethodCall* self = FL_METHOD_CALL(object);
 
  g_clear_pointer(&self->name, g_free);
  g_clear_pointer(&self->args, fl_value_unref);
  g_clear_object(&self->channel);
  g_clear_object(&self->response_handle);
 
  G_OBJECT_CLASS(fl_method_call_parent_class)->dispose(object);
}

fl_method_call_get_args()

G_MODULE_EXPORT FlValue * fl_method_call_get_args

(

FlMethodCall *

method_call

)

fl_method_call_get_args: @method_call: an #FlMethodCall.

Gets the arguments passed to the method.

Returns: an FlValue.

Definition at line 72 of file fl_method_call.cc.

                                                                     {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), nullptr);
  return self->args;
}

fl_method_call_get_name()

G_MODULE_EXPORT const gchar * fl_method_call_get_name

(

FlMethodCall *

method_call

)

FlMethodCall:

#FlMethodCall represents and incoming method call as returned by an #FlMethodChannel. fl_method_call_get_name: @method_call: an #FlMethodCall.

Gets the name of the method call.

Returns: a method name.

Definition at line 67 of file fl_method_call.cc.

                                                                         {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), nullptr);
  return self->name;
}

fl_method_call_init()

static void fl_method_call_init ( FlMethodCall *  self )

static

Definition at line 42 of file fl_method_call.cc.

{}

fl_method_call_new()

FlMethodCall * fl_method_call_new	(	const gchar *	name,
		FlValue *	args,
		FlMethodChannel *	channel,
		FlBinaryMessengerResponseHandle *	response_handle
	)

Definition at line 44 of file fl_method_call.cc.

                                                      {
  g_return_val_if_fail(name != nullptr, nullptr);
  g_return_val_if_fail(args != nullptr, nullptr);
  g_return_val_if_fail(FL_IS_METHOD_CHANNEL(channel), nullptr);
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER_RESPONSE_HANDLE(response_handle),
                       nullptr);
 
  FlMethodCall* self =
      FL_METHOD_CALL(g_object_new(fl_method_call_get_type(), nullptr));
 
  self->name = g_strdup(name);
  self->args = fl_value_ref(args);
  self->channel = FL_METHOD_CHANNEL(g_object_ref(channel));
  self->response_handle =
      FL_BINARY_MESSENGER_RESPONSE_HANDLE(g_object_ref(response_handle));
 
  return self;
}

fl_method_call_respond()

G_MODULE_EXPORT gboolean fl_method_call_respond	(	FlMethodCall *	method_call,
		FlMethodResponse *	response,
		GError **	error
	)

fl_method_call_respond: @method_call: an #FlMethodCall. @response: an #FlMethodResponse. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Responds to a method call.

Returns: TRUE on success.

Definition at line 77 of file fl_method_call.cc.

                                                                {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
  g_return_val_if_fail(FL_IS_METHOD_RESPONSE(response), FALSE);
 
  g_autoptr(GError) local_error = nullptr;
  if (!fl_method_channel_respond(self->channel, self->response_handle, response,
                                 &local_error)) {
    // If the developer chose not to handle the error then log it so it's not
    // missed.
    if (error == nullptr) {
      g_warning("Failed to send method call response: %s",
                local_error->message);
    }
 
    g_propagate_error(error, local_error);
    return FALSE;
  }
 
  return TRUE;
}

fl_method_call_respond_error()

G_MODULE_EXPORT gboolean fl_method_call_respond_error	(	FlMethodCall *	self,
		const gchar *	code,
		const gchar *	message,
		FlValue *	details,
		GError **	error
	)

Definition at line 111 of file fl_method_call.cc.

                                                                      {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
  g_return_val_if_fail(code != nullptr, FALSE);
 
  g_autoptr(FlMethodResponse) response =
      FL_METHOD_RESPONSE(fl_method_error_response_new(code, message, details));
  return fl_method_channel_respond(self->channel, self->response_handle,
                                   response, error);
}

fl_method_call_respond_not_implemented()

G_MODULE_EXPORT gboolean fl_method_call_respond_not_implemented	(	FlMethodCall *	self,
		GError **	error
	)

Definition at line 125 of file fl_method_call.cc.

                    {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
 
  g_autoptr(FlMethodResponse) response =
      FL_METHOD_RESPONSE(fl_method_not_implemented_response_new());
  return fl_method_channel_respond(self->channel, self->response_handle,
                                   response, error);
}

fl_method_call_respond_success()

G_MODULE_EXPORT gboolean fl_method_call_respond_success	(	FlMethodCall *	method_call,
		FlValue *	result,
		GError **	error
	)

fl_method_call_respond_success: @method_call: an #FlMethodCall.

Returns

: (allow-none): value to respond with, must match what the #FlMethodCodec supports. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Convenience method that responds to method call with #FlMethodSuccessResponse.

Returns: TRUE on success.

Definition at line 100 of file fl_method_call.cc.

                                                                        {
  g_return_val_if_fail(FL_IS_METHOD_CALL(self), FALSE);
 
  g_autoptr(FlMethodResponse) response =
      FL_METHOD_RESPONSE(fl_method_success_response_new(result));
  return fl_method_channel_respond(self->channel, self->response_handle,
                                   response, error);
}