C# Class OpenHome.Net.Core.Action

(Service) Action
Each service has 0..n of these. Each action has 0..n input parameters and 0..m output parameters. Each parameter must be either input or output.
Inheritance: IDisposable
Mostra file Open project: openhome/ohNet Class Usage Examples

Public Methods

Method Description
Action ( String aName ) : System

Constructor

AddInputParameter ( Parameter aParameter ) : void

Add an input parameter

AddOutputParameter ( Parameter aParameter ) : void

Add an output parameter

Dispose ( ) : void
InputParameter ( int aIndex ) : Parameter

Retrieve an input parameter

Name ( ) : String

Query the name of the action

OutputParameter ( int aIndex ) : Parameter

Retrieve an output parameter

Private Methods

Method Description
Handle ( ) : IntPtr
ServiceActionAddInputParameter ( IntPtr aAction, IntPtr aParameter ) : void
ServiceActionAddOutputParameter ( IntPtr aAction, IntPtr aParameter ) : void
ServiceActionCreate ( IntPtr aName ) : IntPtr
ServiceActionDestroy ( IntPtr aAction ) : void
ServiceActionGetName ( IntPtr aAction, IntPtr &aName, uint &aLen ) : void

Method Details

Action() public method

Constructor
public Action ( String aName ) : System
aName String Action name
return System

AddInputParameter() public method

Add an input parameter
public AddInputParameter ( Parameter aParameter ) : void
aParameter Parameter Input parameter. Ownership is passed to the action
return void

AddOutputParameter() public method

Add an output parameter
public AddOutputParameter ( Parameter aParameter ) : void
aParameter Parameter Output parameter. Ownership is passed to the action
return void

Dispose() public method

public Dispose ( ) : void
return void

InputParameter() public method

Retrieve an input parameter
public InputParameter ( int aIndex ) : Parameter
aIndex int (Zero-based) Index of the parameter
return Parameter

Name() public method

Query the name of the action
public Name ( ) : String
return String

OutputParameter() public method

Retrieve an output parameter
public OutputParameter ( int aIndex ) : Parameter
aIndex int (Zero-based) Index of the parameter
return Parameter