Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Data Structures | Macros | Typedefs

Modules

 afw_adaptor
 

Data Structures

struct  afw_adaptor_s
 Interface afw_adaptor public struct. More...
 
struct  afw_adaptor_inf_s
 Interface afw_adaptor_inf_s struct. More...
 

Macros

#define AFW_ADAPTOR_INTERFACE_NAME   "afw_adaptor"
 define for interface afw_adaptor name.
 
#define afw_adaptor_destroy(instance, xctx)
 Call method destroy of interface afw_adaptor. More...
 
#define afw_adaptor_create_adaptor_session(instance, xctx)
 Call method create_adaptor_session of interface afw_adaptor. More...
 
#define afw_adaptor_get_additional_metrics(instance, p, xctx)
 Call method get_additional_metrics of interface afw_adaptor. More...
 

Typedefs

typedef void(* afw_adaptor_destroy_t) (const afw_adaptor_t *instance, afw_xctx_t *xctx)
 
typedef const afw_adaptor_session_t *(* afw_adaptor_create_adaptor_session_t) (const afw_adaptor_t *instance, afw_xctx_t *xctx)
 
typedef const afw_object_t *(* afw_adaptor_get_additional_metrics_t) (const afw_adaptor_t *instance, const afw_pool_t *p, afw_xctx_t *xctx)
 

Detailed Description

Adaptor interface.

Macro Definition Documentation

◆ afw_adaptor_create_adaptor_session

#define afw_adaptor_create_adaptor_session (   instance,
  xctx 
)
Value:
(instance)->inf->create_adaptor_session( \
(instance), \
(xctx) \
)

Call method create_adaptor_session of interface afw_adaptor.

Parameters
instancePointer to this adaptor instance.
xctxThe execution context (xctx) of caller.

Definition at line 259 of file afw_interface.h.

◆ afw_adaptor_destroy

#define afw_adaptor_destroy (   instance,
  xctx 
)
Value:
(instance)->inf->destroy( \
(instance), \
(xctx) \
)

Call method destroy of interface afw_adaptor.

Parameters
instancePointer to this adaptor instance.
xctxThis is the caller's xctx.

Definition at line 245 of file afw_interface.h.

◆ afw_adaptor_get_additional_metrics

#define afw_adaptor_get_additional_metrics (   instance,
  p,
  xctx 
)
Value:
(instance)->inf->get_additional_metrics( \
(instance), \
(p), \
(xctx) \
)

Call method get_additional_metrics of interface afw_adaptor.

Parameters
instancePointer to this adaptor instance.
pPool used for results.
xctxThe execution context (xctx) of caller.

Definition at line 274 of file afw_interface.h.

Typedef Documentation

◆ afw_adaptor_create_adaptor_session_t

typedef const afw_adaptor_session_t*(* afw_adaptor_create_adaptor_session_t) (const afw_adaptor_t *instance, afw_xctx_t *xctx)
See also
afw_adaptor_create_adaptor_session()

Definition at line 220 of file afw_interface.h.

◆ afw_adaptor_destroy_t

typedef void(* afw_adaptor_destroy_t) (const afw_adaptor_t *instance, afw_xctx_t *xctx)
See also
afw_adaptor_destroy()

Definition at line 214 of file afw_interface.h.

◆ afw_adaptor_get_additional_metrics_t

typedef const afw_object_t*(* afw_adaptor_get_additional_metrics_t) (const afw_adaptor_t *instance, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_adaptor_get_additional_metrics()

Definition at line 226 of file afw_interface.h.