FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kAxAction Class Reference

Description

Abstract base class for action implementations.

Actions implement the server side of user-defined remote procedure calls on FireSync nodes. Actions have XML settings, and can accept and produce kDat-6 serializable objects when executed.

Inheritance diagram for kAxAction:
Inheritance graph

Public Member Functions

kPointer kAxAction_App (kAxAction action)
 For actions that are run in server context, gets a reference to the local application object (if set). More...
 
kStatus kAxAction_Construct (kAxAction *action, kType type, const kChar *name, kActionTrigger trigger, kAxEnviron actionEnviron, kAlloc allocator)
 Factory constructor for action objects. More...
 
const kCharkAxAction_Description (kType type)
 Given a kAxAction subclass type, gets a description of the class. More...
 
kStatus kAxAction_Invoke (kAxAction action, kObject input, kObject *output, kAlloc alloc)
 Virtual method that can be overridden to perform custom processing when action is invoked. More...
 
const kCharkAxAction_Name (kAxAction action)
 Gets a descriptive name for the action instance. More...
 
kNode kAxAction_Node (kAxAction action)
 Gets a reference to a kNode object representing the local node. More...
 
kXml kAxAction_Settings (kAxAction action)
 Returns the action's settings. More...
 
kSystem kAxAction_System (kAxAction action)
 Gets a reference to a kSystem object representing the collection of discovered nodes. More...
 
kActionTrigger kAxAction_Trigger (kAxAction action)
 Gets the action trigger source. More...
 
kStatus kAxAction_Validate (kType type, kXml settings, kAlloc alloc)
 Virtual method that can be overridden to perform XML settings validation. More...
 

The documentation for this class was generated from the following file: