amxd_function.c File Reference

#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <amxc/amxc.h>
#include <amxp/amxp_signal.h>
#include <amxp/amxp_slot.h>
#include <amxd/amxd_common.h>
#include <amxd/amxd_types.h>
#include <amxd/amxd_object.h>
#include <amxd/amxd_function.h>
#include "amxd_priv.h"
#include "amxd_assert.h"
#include "amxd_dm_priv.h"

Go to the source code of this file.

Macros
#define	_GNU_SOURCE

Functions
static void	amxd_function_free_arg_it (amxc_llist_it_t *it)
static amxd_status_t	amxd_function_init (amxd_function_t *const func, const char *name, uint32_t ret_type, amxd_object_fn_t impl)
static int	amxd_function_clean (amxd_function_t *const func)
static uint32_t	amxd_function_get_attributes (const amxd_function_t *const func)
static void	amxd_function_set_attributes (amxd_function_t *const func, const uint32_t attr)
amxd_status_t	amxd_function_new (amxd_function_t **func, const char *name, const uint32_t ret_type, amxd_object_fn_t impl)
	Data model RPC method constructor function. More...
void	amxd_function_delete (amxd_function_t **func)
	Data model RPC method destructor function. More...
amxd_status_t	amxd_function_copy (amxd_function_t **dest, const amxd_function_t *const source)
	Data model RPC method copy constructor function. More...
amxd_object_t *	amxd_function_get_owner (const amxd_function_t *const func)
	Get the object pointer of the object containing the function definition. More...
amxd_function_t *	amxd_function_get_base (const amxd_function_t *const func)
	Get the base function definition of an overridden function. More...
amxd_status_t	amxd_function_call_base (const amxd_function_t *const func, amxd_object_t *const object, amxc_var_t *const args, amxc_var_t *const ret)
	Call the base function of an overridden function. More...
const char *	amxd_function_get_name (const amxd_function_t *const func)
	Get the name of a method. More...
amxd_status_t	amxd_function_set_attr (amxd_function_t *func, const amxd_fattr_id_t attr, const bool enable)
	Sets or unsets a method attribute. More...
amxd_status_t	amxd_function_set_attrs (amxd_function_t *func, const uint32_t bitmask, bool enable)
	Sets or unsets method attributes using a bitmap. More...
uint32_t	amxd_function_get_attrs (const amxd_function_t *const func)
	Gets the set attributes of a RPC method. More...
bool	amxd_function_is_attr_set (const amxd_function_t *const func, const amxd_fattr_id_t attr)
	Checks if a method attribute is set. More...
void	amxd_function_set_flag (amxd_function_t *func, const char *flag)
	Sets a flag on a function. More...
void	amxd_function_unset_flag (amxd_function_t *func, const char *flag)
	Removes a flag from a function. More...
bool	amxd_function_has_flag (const amxd_function_t *const func, const char *flag)
	Checks if a flag is set. More...
amxd_status_t	amxd_function_set_impl (amxd_function_t *const func, amxd_object_fn_t impl)
	Set an implementation for a RPC method. More...
amxd_status_t	amxd_function_describe (amxd_function_t *const func, amxc_var_t *const value)
	Fetches the full RPC method definition in a variant. More...
amxd_func_arg_t *	amxd_function_get_arg (const amxd_function_t *const func, const char *name)
	Gets the argument definition of a RPC method. More...
bool	amxd_function_are_args_valid (amxd_function_t *func, amxc_var_t *args)
	Validates that the input arguments are valid. More...

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Definition at line 56 of file amxd_function.c.

Function Documentation

amxd_function_clean()

static int amxd_function_clean ( amxd_function_t *const  func )

static

Definition at line 112 of file amxd_function.c.

                                                            {
    amxc_llist_it_take(&func->it);
    amxc_llist_clean(&func->args, amxd_function_free_arg_it);
    amxc_var_delete(&func->flags);
 
    free(func->name);
    func->name = NULL;
    func->impl = NULL;
 
    return 0;
}

amxd_function_free_arg_it()

static void amxd_function_free_arg_it ( amxc_llist_it_t *  it )

static

Definition at line 77 of file amxd_function.c.

                                                           {
    amxd_func_arg_t* arg = amxc_llist_it_get_data(it, amxd_func_arg_t, it);
    amxd_function_arg_clean(arg);
    free(arg);
}

amxd_function_get_attributes()

static uint32_t amxd_function_get_attributes ( const amxd_function_t *const  func )

static

Definition at line 124 of file amxd_function.c.

                                                                                {
 
    uint32_t attributes = 0;
 
    attributes |= func->attr.templ << amxd_fattr_template;
    attributes |= func->attr.instance << amxd_fattr_instance;
    attributes |= func->attr.priv << amxd_fattr_private;
    attributes |= func->attr.prot << amxd_fattr_protected;
    attributes |= func->attr.async << amxd_fattr_async;
 
    return attributes;
}

amxd_function_init()

static amxd_status_t amxd_function_init ( amxd_function_t *const  func, const char *  name, uint32_t  ret_type, amxd_object_fn_t  impl  )

static

Definition at line 83 of file amxd_function.c.

                                                               {
    amxd_status_t retval = amxd_status_unknown_error;
 
    amxc_llist_it_init(&func->it);
 
    func->attr.templ = 0;
    func->attr.instance = 0;
    func->attr.priv = 0;
    func->attr.prot = 0;
 
    if((ret_type == AMXC_VAR_ID_ANY) ||
       ( amxc_var_get_type(ret_type) != NULL)) {
        func->name = strdup(name);
        when_null(func->name, exit);
 
        amxc_llist_init(&func->args);
        func->ret_type = ret_type;
        func->impl = impl;
 
        retval = amxd_status_ok;
    }
 
exit:
    return retval;
}

amxd_function_set_attributes()

static void amxd_function_set_attributes ( amxd_function_t *const  func, const uint32_t  attr  )

static

Definition at line 137 of file amxd_function.c.

                                                              {
    func->attr.templ = IS_BIT_SET(attr, amxd_fattr_template);
    func->attr.instance = IS_BIT_SET(attr, amxd_fattr_instance);
    func->attr.priv = IS_BIT_SET(attr, amxd_fattr_private);
    func->attr.prot = IS_BIT_SET(attr, amxd_fattr_protected);
    func->attr.async = IS_BIT_SET(attr, amxd_fattr_async);
}