C# Class OpenHome.Net.Device.Providers.DvProviderOpenhomeOrgSubscriptionLongPoll1

Provider for the openhome.org:SubscriptionLongPoll:1 UPnP service
Inheritance: DvProvider, IDisposable, IDvProviderOpenhomeOrgSubscriptionLongPoll1
Mostrar archivo Open project: openhome/ohNet Class Usage Examples

Public Methods

Method Description
Dispose ( ) : void

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

Protected Methods

Method Description
DvProviderOpenhomeOrgSubscriptionLongPoll1 ( DvDevice aDevice ) : System

Constructor

EnableActionGetPropertyUpdates ( ) : void

Signal that the action GetPropertyUpdates is supported.

The action's availability will be published in the device's service.xml. GetPropertyUpdates must be overridden if this is called.

EnableActionRenew ( ) : void

Signal that the action Renew is supported.

The action's availability will be published in the device's service.xml. Renew must be overridden if this is called.

EnableActionSubscribe ( ) : void

Signal that the action Subscribe is supported.

The action's availability will be published in the device's service.xml. Subscribe must be overridden if this is called.

EnableActionUnsubscribe ( ) : void

Signal that the action Unsubscribe is supported.

The action's availability will be published in the device's service.xml. Unsubscribe must be overridden if this is called.

GetPropertyUpdates ( IDvInvocation aInvocation, string aClientId, string &aUpdates ) : void

GetPropertyUpdates action.

Will be called when the device stack receives an invocation of the GetPropertyUpdates action for the owning device. Must be implemented iff EnableActionGetPropertyUpdates was called.

Renew ( IDvInvocation aInvocation, string aSid, uint aRequestedDuration, uint &aDuration ) : void

Renew action.

Will be called when the device stack receives an invocation of the Renew action for the owning device. Must be implemented iff EnableActionRenew was called.

Subscribe ( IDvInvocation aInvocation, string aClientId, string aUdn, string aService, uint aRequestedDuration, string &aSid, uint &aDuration ) : void

Subscribe action.

Will be called when the device stack receives an invocation of the Subscribe action for the owning device. Must be implemented iff EnableActionSubscribe was called.

Unsubscribe ( IDvInvocation aInvocation, string aSid ) : void

Unsubscribe action.

Will be called when the device stack receives an invocation of the Unsubscribe action for the owning device. Must be implemented iff EnableActionUnsubscribe was called.

Private Methods

Method Description
DoGetPropertyUpdates ( IntPtr aPtr, IntPtr aInvocation ) : int
DoRenew ( IntPtr aPtr, IntPtr aInvocation ) : int
DoSubscribe ( IntPtr aPtr, IntPtr aInvocation ) : int
DoUnsubscribe ( IntPtr aPtr, IntPtr aInvocation ) : int

Method Details

Dispose() public method

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

DvProviderOpenhomeOrgSubscriptionLongPoll1() protected method

Constructor
protected DvProviderOpenhomeOrgSubscriptionLongPoll1 ( DvDevice aDevice ) : System
aDevice DvDevice Device which owns this provider
return System

EnableActionGetPropertyUpdates() protected method

Signal that the action GetPropertyUpdates is supported.
The action's availability will be published in the device's service.xml. GetPropertyUpdates must be overridden if this is called.
protected EnableActionGetPropertyUpdates ( ) : void
return void

EnableActionRenew() protected method

Signal that the action Renew is supported.
The action's availability will be published in the device's service.xml. Renew must be overridden if this is called.
protected EnableActionRenew ( ) : void
return void

EnableActionSubscribe() protected method

Signal that the action Subscribe is supported.
The action's availability will be published in the device's service.xml. Subscribe must be overridden if this is called.
protected EnableActionSubscribe ( ) : void
return void

EnableActionUnsubscribe() protected method

Signal that the action Unsubscribe is supported.
The action's availability will be published in the device's service.xml. Unsubscribe must be overridden if this is called.
protected EnableActionUnsubscribe ( ) : void
return void

GetPropertyUpdates() protected method

GetPropertyUpdates action.
Will be called when the device stack receives an invocation of the GetPropertyUpdates action for the owning device. Must be implemented iff EnableActionGetPropertyUpdates was called.
protected GetPropertyUpdates ( IDvInvocation aInvocation, string aClientId, string &aUpdates ) : void
aInvocation IDvInvocation Interface allowing querying of aspects of this particular action invocation.
aClientId string
aUpdates string
return void

Renew() protected method

Renew action.
Will be called when the device stack receives an invocation of the Renew action for the owning device. Must be implemented iff EnableActionRenew was called.
protected Renew ( IDvInvocation aInvocation, string aSid, uint aRequestedDuration, uint &aDuration ) : void
aInvocation IDvInvocation Interface allowing querying of aspects of this particular action invocation.
aSid string
aRequestedDuration uint
aDuration uint
return void

Subscribe() protected method

Subscribe action.
Will be called when the device stack receives an invocation of the Subscribe action for the owning device. Must be implemented iff EnableActionSubscribe was called.
protected Subscribe ( IDvInvocation aInvocation, string aClientId, string aUdn, string aService, uint aRequestedDuration, string &aSid, uint &aDuration ) : void
aInvocation IDvInvocation Interface allowing querying of aspects of this particular action invocation.
aClientId string
aUdn string
aService string
aRequestedDuration uint
aSid string
aDuration uint
return void

Unsubscribe() protected method

Unsubscribe action.
Will be called when the device stack receives an invocation of the Unsubscribe action for the owning device. Must be implemented iff EnableActionUnsubscribe was called.
protected Unsubscribe ( IDvInvocation aInvocation, string aSid ) : void
aInvocation IDvInvocation Interface allowing querying of aspects of this particular action invocation.
aSid string
return void