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

Proxy for the openhome.org:SubscriptionLongPoll:1 UPnP service

Inheritance: OpenHome.Net.ControlPoint.CpProxy, IDisposable, ICpProxyOpenhomeOrgSubscriptionLongPoll1

Show file Open project: openhome/ohNet Class Usage Examples

Public Methods

Method	Description
BeginGetPropertyUpdates ( String aClientId, 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 EndGetPropertyUpdates().
BeginRenew ( String aSid, uint aRequestedDuration, 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 EndRenew().
BeginSubscribe ( String aClientId, String aUdn, String aService, uint aRequestedDuration, 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 EndSubscribe().
BeginUnsubscribe ( String aSid, 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 EndUnsubscribe().
CpProxyOpenhomeOrgSubscriptionLongPoll1 ( ICpDevice 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().
EndGetPropertyUpdates ( IntPtr aAsyncHandle, String &aUpdates ) : void	Retrieve the output arguments from an asynchronously invoked action. This may only be called from the callback set in the above Begin function.
EndRenew ( IntPtr aAsyncHandle, uint &aDuration ) : void	Retrieve the output arguments from an asynchronously invoked action. This may only be called from the callback set in the above Begin function.
EndSubscribe ( IntPtr aAsyncHandle, String &aSid, uint &aDuration ) : void	Retrieve the output arguments from an asynchronously invoked action. This may only be called from the callback set in the above Begin function.
EndUnsubscribe ( 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.
SyncGetPropertyUpdates ( String aClientId, String &aUpdates ) : void	Invoke the action synchronously Blocks until the action has been processed on the device and sets any output arguments
SyncRenew ( String aSid, uint aRequestedDuration, uint &aDuration ) : void	Invoke the action synchronously Blocks until the action has been processed on the device and sets any output arguments
SyncSubscribe ( String aClientId, String aUdn, String aService, uint aRequestedDuration, String &aSid, uint &aDuration ) : void	Invoke the action synchronously Blocks until the action has been processed on the device and sets any output arguments
SyncUnsubscribe ( String aSid ) : void	Invoke the action synchronously Blocks until the action has been processed on the device and sets any output arguments

Method Details

BeginGetPropertyUpdates() 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 EndGetPropertyUpdates().

public BeginGetPropertyUpdates ( String aClientId, CallbackAsyncComplete aCallback ) : void
aClientId	String
aCallback	CallbackAsyncComplete	Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return	void

BeginRenew() 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 EndRenew().

public BeginRenew ( String aSid, uint aRequestedDuration, CallbackAsyncComplete aCallback ) : void
aSid	String
aRequestedDuration	uint
aCallback	CallbackAsyncComplete	Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return	void

BeginSubscribe() 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 EndSubscribe().

public BeginSubscribe ( String aClientId, String aUdn, String aService, uint aRequestedDuration, CallbackAsyncComplete aCallback ) : void
aClientId	String
aUdn	String
aService	String
aRequestedDuration	uint
aCallback	CallbackAsyncComplete	Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return	void

BeginUnsubscribe() 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 EndUnsubscribe().

public BeginUnsubscribe ( String aSid, CallbackAsyncComplete aCallback ) : void
aSid	String
aCallback	CallbackAsyncComplete	Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return	void

CpProxyOpenhomeOrgSubscriptionLongPoll1() public method

Constructor

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

public CpProxyOpenhomeOrgSubscriptionLongPoll1 ( ICpDevice aDevice ) : System
aDevice	ICpDevice	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

EndGetPropertyUpdates() 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 EndGetPropertyUpdates ( IntPtr aAsyncHandle, String &aUpdates ) : void
aAsyncHandle	System.IntPtr	Argument passed to the delegate set in the above Begin function
aUpdates	String
return	void

EndRenew() 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 EndRenew ( IntPtr aAsyncHandle, uint &aDuration ) : void
aAsyncHandle	System.IntPtr	Argument passed to the delegate set in the above Begin function
aDuration	uint
return	void

EndSubscribe() 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 EndSubscribe ( IntPtr aAsyncHandle, String &aSid, uint &aDuration ) : void
aAsyncHandle	System.IntPtr	Argument passed to the delegate set in the above Begin function
aSid	String
aDuration	uint
return	void

EndUnsubscribe() 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 EndUnsubscribe ( IntPtr aAsyncHandle ) : void
aAsyncHandle	System.IntPtr	Argument passed to the delegate set in the above Begin function
return	void

SyncGetPropertyUpdates() public method

Invoke the action synchronously

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

public SyncGetPropertyUpdates ( String aClientId, String &aUpdates ) : void
aClientId	String
aUpdates	String
return	void

SyncRenew() public method

Invoke the action synchronously

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

public SyncRenew ( String aSid, uint aRequestedDuration, uint &aDuration ) : void
aSid	String
aRequestedDuration	uint
aDuration	uint
return	void

SyncSubscribe() public method

Invoke the action synchronously

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

public SyncSubscribe ( String aClientId, String aUdn, String aService, uint aRequestedDuration, String &aSid, uint &aDuration ) : void
aClientId	String
aUdn	String
aService	String
aRequestedDuration	uint
aSid	String
aDuration	uint
return	void

SyncUnsubscribe() public method

Invoke the action synchronously

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

public SyncUnsubscribe ( String aSid ) : void
aSid	String
return	void