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

Modules

 afw_service_type
 

Data Structures

struct  afw_service_type_s
 Interface afw_service_type public struct. More...
 
struct  afw_service_type_inf_s
 Interface afw_service_type_inf_s struct. More...
 

Macros

#define AFW_SERVICE_TYPE_INTERFACE_NAME   "afw_service_type"
 define for interface afw_service_type name.
 
#define afw_service_type_related_instance_count(instance, id, xctx)
 Call method related_instance_count of interface afw_service_type. More...
 
#define afw_service_type_start_cede_p(instance, properties, p, xctx)
 Call method start_cede_p of interface afw_service_type. More...
 
#define afw_service_type_stop(instance, id, xctx)
 Call method stop of interface afw_service_type. More...
 
#define afw_service_type_restart_cede_p(instance, properties, p, xctx)
 Call method restart_cede_p of interface afw_service_type. More...
 

Typedefs

typedef afw_integer_t(* afw_service_type_related_instance_count_t) (const afw_service_type_t *instance, const afw_utf8_t *id, afw_xctx_t *xctx)
 
typedef void(* afw_service_type_start_cede_p_t) (const afw_service_type_t *instance, const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
 
typedef void(* afw_service_type_stop_t) (const afw_service_type_t *instance, const afw_utf8_t *id, afw_xctx_t *xctx)
 
typedef void(* afw_service_type_restart_cede_p_t) (const afw_service_type_t *instance, const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
 

Detailed Description

Adaptive framework service type interface. Each instance is registered in the environment with type of "service_type" and id of the service type id.

Macro Definition Documentation

◆ afw_service_type_related_instance_count

#define afw_service_type_related_instance_count (   instance,
  id,
  xctx 
)
Value:
(instance)->inf->related_instance_count( \
(instance), \
(id), \
(xctx) \
)

Call method related_instance_count of interface afw_service_type.

Parameters
instancePointer to this adaptive service type instance.
idValue of appropriate id property for type.
xctxThis is the caller's xctx.

Definition at line 3618 of file afw_interface.h.

◆ afw_service_type_restart_cede_p

#define afw_service_type_restart_cede_p (   instance,
  properties,
  p,
  xctx 
)
Value:
(instance)->inf->restart_cede_p( \
(instance), \
(properties), \
(p), \
(xctx) \
)

Call method restart_cede_p of interface afw_service_type.

Parameters
instancePointer to this adaptive service type instance.
propertiesProperties for start. This object will already be checked to insure the appropriate id and subtype property is present for the type. Other than that, these properties need to be validated using
/afw/_AdaptiveObjectType_/_AdaptiveConf_<type>_<subtype>.
pPool to cede to start.
xctxThis is the caller's xctx.

Definition at line 3681 of file afw_interface.h.

◆ afw_service_type_start_cede_p

#define afw_service_type_start_cede_p (   instance,
  properties,
  p,
  xctx 
)
Value:
(instance)->inf->start_cede_p( \
(instance), \
(properties), \
(p), \
(xctx) \
)

Call method start_cede_p of interface afw_service_type.

Parameters
instancePointer to this adaptive service type instance.
propertiesProperties for start. This object will already be checked to insure the appropriate id and subtype property is present for the type. Other than that, these properties need to be validated using
/afw/_AdaptiveObjectType_/_AdaptiveConf_<type>_<subtype>.
pPool to cede to start.
xctxThis is the caller's xctx.

Definition at line 3640 of file afw_interface.h.

◆ afw_service_type_stop

#define afw_service_type_stop (   instance,
  id,
  xctx 
)
Value:
(instance)->inf->stop( \
(instance), \
(id), \
(xctx) \
)

Call method stop of interface afw_service_type.

Parameters
instancePointer to this adaptive service type instance.
idValue of appropriate id property for type.
xctxThis is the caller's xctx.

Definition at line 3659 of file afw_interface.h.

Typedef Documentation

◆ afw_service_type_related_instance_count_t

typedef afw_integer_t(* afw_service_type_related_instance_count_t) (const afw_service_type_t *instance, const afw_utf8_t *id, afw_xctx_t *xctx)
See also
afw_service_type_related_instance_count()

Definition at line 3574 of file afw_interface.h.

◆ afw_service_type_restart_cede_p_t

typedef void(* afw_service_type_restart_cede_p_t) (const afw_service_type_t *instance, const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_service_type_restart_cede_p()

Definition at line 3596 of file afw_interface.h.

◆ afw_service_type_start_cede_p_t

typedef void(* afw_service_type_start_cede_p_t) (const afw_service_type_t *instance, const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_service_type_start_cede_p()

Definition at line 3581 of file afw_interface.h.

◆ afw_service_type_stop_t

typedef void(* afw_service_type_stop_t) (const afw_service_type_t *instance, const afw_utf8_t *id, afw_xctx_t *xctx)
See also
afw_service_type_stop()

Definition at line 3589 of file afw_interface.h.