iokit/IOKit/IOCommandGate.h

43 that executes an action on the driver's work-loop.  'On the work-loop' is
52 client to submit a request to a work loop.  A typical command gate action would
70 through from the runCommand to the action callout.
76     @param arg0 Argument to action from run operation.
77     @param arg1 Argument to action from run operation.
78     @param arg2 Argument to action from run operation.
79     @param arg3 Argument to action from run operation.
100     static IOCommandGate *commandGate(OSObject *owner, Action action = 0);
106     @param owner 	Owner of this, newly created, instance of the IOCommandGate.  This argument will be used as the first parameter in the action callout.
107     @param action
113     virtual bool init(OSObject *owner, Action action = 0);
121     @discussion Client function that causes the current action to be called in
125 execution of client actions, the action is single threaded against all other
127     @param arg0 Parameter for action of command gate, defaults to 0.
128     @param arg1 Parameter for action of command gate, defaults to 0.
129     @param arg2 Parameter for action of command gate, defaults to 0.
130     @param arg3 Parameter for action of command gate, defaults to 0.
131     @result kIOReturnSuccess if successful. kIOReturnAborted if a disabled command gate is free()ed before being reenabled, kIOReturnNoResources if no action available.
137     @abstract Single thread a call to an action with the target work-loop.
138     @discussion Client function that causes the given action to be called in
142 execution of client actions, the action is single threaded against all other
144     @param action Pointer to function to be executed in work-loop context.
145     @param arg0 Parameter for action parameter, defaults to 0.
146     @param arg1 Parameter for action parameter, defaults to 0.
147     @param arg2 Parameter for action parameter, defaults to 0.
148     @param arg3 Parameter for action parameter, defaults to 0.
149     @result kIOReturnSuccess if successful. kIOReturnBadArgument if action is not defined, kIOReturnAborted if a disabled command gate is free()ed before being reenabled.
151     virtual IOReturn runAction(Action action,
157     @discussion Client function that causes the current action to be called in
159     @param arg0 Parameter for action of command gate, defaults to 0.
160     @param arg1 Parameter for action of command gate, defaults to 0.
161     @param arg2 Parameter for action of command gate, defaults to 0.
162     @param arg3 Parameter for action of command gate, defaults to 0.
163     @result kIOReturnSuccess if successful. kIOReturnNotPermitted if this event source is currently disabled, kIOReturnNoResources if no action available, kIOReturnCannotLock if lock attempt fails.
169     @abstract Single thread a call to an action with the target work-loop.
170     @discussion Client function that causes the given action to be called in
174     @param action Pointer to function to be executed in work-loop context.
175     @param arg0 Parameter for action parameter, defaults to 0.
176     @param arg1 Parameter for action parameter, defaults to 0.
177     @param arg2 Parameter for action parameter, defaults to 0.
178     @param arg3 Parameter for action parameter, defaults to 0.
179     @result kIOReturnSuccess if successful. kIOReturnBadArgument if action is not defined, kIOReturnNotPermitted if this event source is currently disabled, kIOReturnCannotLock if lock attempt fails.
182     virtual IOReturn attemptAction(Action action,