C# Class OpenHome.Net.ControlPoint.Proxies.CpProxyRaumfeldComConfigService1

Proxy for the raumfeld.com:ConfigService:1 UPnP service
Inheritance: OpenHome.Net.ControlPoint.CpProxy, IDisposable, ICpProxyRaumfeldComConfigService1
Datei anzeigen Open project: stoennies/raumwiese Class Usage Examples

Public Methods

Method Description
BeginGetDevice ( String aService, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetDevice().

BeginGetPreferences ( String aPublicKey, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetPreferences().

BeginGetPublicKey ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetPublicKey().

BeginGetRevision ( CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetRevision().

BeginSetPreferences ( String aPreferences, String aLeastCommonChangedNode, uint aExpectedRevision, String aOnConflict, CallbackAsyncComplete aCallback ) : void

Invoke the action asynchronously

Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndSetPreferences().

CpProxyRaumfeldComConfigService1 ( CpDevice aDevice ) : System

Constructor

Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.

Dispose ( ) : void

Must be called for each class instance. Must be called before Core.Library.Close().

EndGetDevice ( IntPtr aAsyncHandle, String &aUniqueDeviceName ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetPreferences ( IntPtr aAsyncHandle, String &aPreferences, uint &aRevision ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetPublicKey ( IntPtr aAsyncHandle, String &aKey ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndGetRevision ( IntPtr aAsyncHandle, uint &aRevision ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

EndSetPreferences ( IntPtr aAsyncHandle ) : void

Retrieve the output arguments from an asynchronously invoked action.

This may only be called from the callback set in the above Begin function.

PropertyARG_TYPE_OnConflict ( ) : String

Query the value of the ARG_TYPE_OnConflict property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

PropertyLastChange ( ) : String

Query the value of the LastChange property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

PropertyRevision ( ) : uint

Query the value of the Revision property.

This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().

SetPropertyARG_TYPE_OnConflictChanged ( System aARG_TYPE_OnConflictChanged ) : void

Set a delegate to be run when the ARG_TYPE_OnConflict state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.

SetPropertyLastChangeChanged ( System aLastChangeChanged ) : void

Set a delegate to be run when the LastChange state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.

SetPropertyRevisionChanged ( System aRevisionChanged ) : void

Set a delegate to be run when the Revision state variable changes.

Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.

SyncGetDevice ( String aService, String &aUniqueDeviceName ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetPreferences ( String aPublicKey, String &aPreferences, uint &aRevision ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetPublicKey ( String &aKey ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncGetRevision ( uint &aRevision ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

SyncSetPreferences ( String aPreferences, String aLeastCommonChangedNode, uint aExpectedRevision, String aOnConflict ) : void

Invoke the action synchronously

Blocks until the action has been processed on the device and sets any output arguments

Private Methods

Method Description
ARG_TYPE_OnConflictPropertyChanged ( ) : void
LastChangePropertyChanged ( ) : void
RevisionPropertyChanged ( ) : void

Method Details

BeginGetDevice() public method

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetDevice().
public BeginGetDevice ( String aService, CallbackAsyncComplete aCallback ) : void
aService String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginGetPreferences() public method

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetPreferences().
public BeginGetPreferences ( String aPublicKey, CallbackAsyncComplete aCallback ) : void
aPublicKey String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginGetPublicKey() public method

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetPublicKey().
public BeginGetPublicKey ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginGetRevision() public method

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndGetRevision().
public BeginGetRevision ( CallbackAsyncComplete aCallback ) : void
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginSetPreferences() public method

Invoke the action asynchronously
Returns immediately and will run the client-specified callback when the action later completes. Any output arguments can then be retrieved by calling EndSetPreferences().
public BeginSetPreferences ( String aPreferences, String aLeastCommonChangedNode, uint aExpectedRevision, String aOnConflict, CallbackAsyncComplete aCallback ) : void
aPreferences String
aLeastCommonChangedNode String
aExpectedRevision uint
aOnConflict String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

CpProxyRaumfeldComConfigService1() public method

Constructor
Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.
public CpProxyRaumfeldComConfigService1 ( CpDevice aDevice ) : System
aDevice OpenHome.Net.ControlPoint.CpDevice The device to use
return System

Dispose() public method

Must be called for each class instance. Must be called before Core.Library.Close().
public Dispose ( ) : void
return void

EndGetDevice() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetDevice ( IntPtr aAsyncHandle, String &aUniqueDeviceName ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aUniqueDeviceName String
return void

EndGetPreferences() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetPreferences ( IntPtr aAsyncHandle, String &aPreferences, uint &aRevision ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aPreferences String
aRevision uint
return void

EndGetPublicKey() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetPublicKey ( IntPtr aAsyncHandle, String &aKey ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aKey String
return void

EndGetRevision() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndGetRevision ( IntPtr aAsyncHandle, uint &aRevision ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aRevision uint
return void

EndSetPreferences() public method

Retrieve the output arguments from an asynchronously invoked action.
This may only be called from the callback set in the above Begin function.
public EndSetPreferences ( IntPtr aAsyncHandle ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
return void

PropertyARG_TYPE_OnConflict() public method

Query the value of the ARG_TYPE_OnConflict property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyARG_TYPE_OnConflict ( ) : String
return String

PropertyLastChange() public method

Query the value of the LastChange property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyLastChange ( ) : String
return String

PropertyRevision() public method

Query the value of the Revision property.
This function is threadsafe and can only be called if Subscribe() has been called and a first eventing callback received more recently than any call to Unsubscribe().
public PropertyRevision ( ) : uint
return uint

SetPropertyARG_TYPE_OnConflictChanged() public method

Set a delegate to be run when the ARG_TYPE_OnConflict state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.
public SetPropertyARG_TYPE_OnConflictChanged ( System aARG_TYPE_OnConflictChanged ) : void
aARG_TYPE_OnConflictChanged System The delegate to run when the state variable changes
return void

SetPropertyLastChangeChanged() public method

Set a delegate to be run when the LastChange state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.
public SetPropertyLastChangeChanged ( System aLastChangeChanged ) : void
aLastChangeChanged System The delegate to run when the state variable changes
return void

SetPropertyRevisionChanged() public method

Set a delegate to be run when the Revision state variable changes.
Callbacks may be run in different threads but callbacks for a CpProxyRaumfeldComConfigService1 instance will not overlap.
public SetPropertyRevisionChanged ( System aRevisionChanged ) : void
aRevisionChanged System The delegate to run when the state variable changes
return void

SyncGetDevice() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetDevice ( String aService, String &aUniqueDeviceName ) : void
aService String
aUniqueDeviceName String
return void

SyncGetPreferences() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetPreferences ( String aPublicKey, String &aPreferences, uint &aRevision ) : void
aPublicKey String
aPreferences String
aRevision uint
return void

SyncGetPublicKey() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetPublicKey ( String &aKey ) : void
aKey String
return void

SyncGetRevision() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetRevision ( uint &aRevision ) : void
aRevision uint
return void

SyncSetPreferences() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncSetPreferences ( String aPreferences, String aLeastCommonChangedNode, uint aExpectedRevision, String aOnConflict ) : void
aPreferences String
aLeastCommonChangedNode String
aExpectedRevision uint
aOnConflict String
return void