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

Provider for the upnp.org:ConnectionManager:1 UPnP service

Inheritance: DvProvider, IDisposable, IDvProviderUpnpOrgConnectionManager1

Exibir arquivo 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().
EnablePropertyCurrentConnectionIDs ( ) : void	Enable the CurrentConnectionIDs property.
EnablePropertySinkProtocolInfo ( ) : void	Enable the SinkProtocolInfo property.
EnablePropertySourceProtocolInfo ( ) : void	Enable the SourceProtocolInfo property.
PropertyCurrentConnectionIDs ( ) : string	Get a copy of the value of the CurrentConnectionIDs property Can only be called if EnablePropertyCurrentConnectionIDs has previously been called.
PropertySinkProtocolInfo ( ) : string	Get a copy of the value of the SinkProtocolInfo property Can only be called if EnablePropertySinkProtocolInfo has previously been called.
PropertySourceProtocolInfo ( ) : string	Get a copy of the value of the SourceProtocolInfo property Can only be called if EnablePropertySourceProtocolInfo has previously been called.
SetPropertyCurrentConnectionIDs ( string aValue ) : bool	Set the value of the CurrentConnectionIDs property Can only be called if EnablePropertyCurrentConnectionIDs has previously been called.
SetPropertySinkProtocolInfo ( string aValue ) : bool	Set the value of the SinkProtocolInfo property Can only be called if EnablePropertySinkProtocolInfo has previously been called.
SetPropertySourceProtocolInfo ( string aValue ) : bool	Set the value of the SourceProtocolInfo property Can only be called if EnablePropertySourceProtocolInfo has previously been called.

Protected Methods

Method	Description
ConnectionComplete ( IDvInvocation aInvocation, int aConnectionID ) : void	ConnectionComplete action. Will be called when the device stack receives an invocation of the ConnectionComplete action for the owning device. Must be implemented iff EnableActionConnectionComplete was called.
DvProviderUpnpOrgConnectionManager1 ( DvDevice aDevice ) : System	Constructor
EnableActionConnectionComplete ( ) : void	Signal that the action ConnectionComplete is supported. The action's availability will be published in the device's service.xml. ConnectionComplete must be overridden if this is called.
EnableActionGetCurrentConnectionIDs ( ) : void	Signal that the action GetCurrentConnectionIDs is supported. The action's availability will be published in the device's service.xml. GetCurrentConnectionIDs must be overridden if this is called.
EnableActionGetCurrentConnectionInfo ( ) : void	Signal that the action GetCurrentConnectionInfo is supported. The action's availability will be published in the device's service.xml. GetCurrentConnectionInfo must be overridden if this is called.
EnableActionGetProtocolInfo ( ) : void	Signal that the action GetProtocolInfo is supported. The action's availability will be published in the device's service.xml. GetProtocolInfo must be overridden if this is called.
EnableActionPrepareForConnection ( ) : void	Signal that the action PrepareForConnection is supported. The action's availability will be published in the device's service.xml. PrepareForConnection must be overridden if this is called.
GetCurrentConnectionIDs ( IDvInvocation aInvocation, string &aConnectionIDs ) : void	GetCurrentConnectionIDs action. Will be called when the device stack receives an invocation of the GetCurrentConnectionIDs action for the owning device. Must be implemented iff EnableActionGetCurrentConnectionIDs was called.
GetCurrentConnectionInfo ( IDvInvocation aInvocation, int aConnectionID, int &aRcsID, int &aAVTransportID, string &aProtocolInfo, string &aPeerConnectionManager, int &aPeerConnectionID, string &aDirection, string &aStatus ) : void	GetCurrentConnectionInfo action. Will be called when the device stack receives an invocation of the GetCurrentConnectionInfo action for the owning device. Must be implemented iff EnableActionGetCurrentConnectionInfo was called.
GetProtocolInfo ( IDvInvocation aInvocation, string &aSource, string &aSink ) : void	GetProtocolInfo action. Will be called when the device stack receives an invocation of the GetProtocolInfo action for the owning device. Must be implemented iff EnableActionGetProtocolInfo was called.
PrepareForConnection ( IDvInvocation aInvocation, string aRemoteProtocolInfo, string aPeerConnectionManager, int aPeerConnectionID, string aDirection, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void	PrepareForConnection action. Will be called when the device stack receives an invocation of the PrepareForConnection action for the owning device. Must be implemented iff EnableActionPrepareForConnection was called.

Private Methods

Method	Description
DoConnectionComplete ( IntPtr aPtr, IntPtr aInvocation ) : int
DoGetCurrentConnectionIDs ( IntPtr aPtr, IntPtr aInvocation ) : int
DoGetCurrentConnectionInfo ( IntPtr aPtr, IntPtr aInvocation ) : int
DoGetProtocolInfo ( IntPtr aPtr, IntPtr aInvocation ) : int
DoPrepareForConnection ( IntPtr aPtr, IntPtr aInvocation ) : int

Method Details

ConnectionComplete() protected method

ConnectionComplete action.

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

protected ConnectionComplete ( IDvInvocation aInvocation, int aConnectionID ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aConnectionID	int
return	void

Dispose() public method

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

public Dispose ( ) : void
return	void

DvProviderUpnpOrgConnectionManager1() protected method

Constructor

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

EnableActionConnectionComplete() protected method

Signal that the action ConnectionComplete is supported.

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

protected EnableActionConnectionComplete ( ) : void
return	void

EnableActionGetCurrentConnectionIDs() protected method

Signal that the action GetCurrentConnectionIDs is supported.

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

protected EnableActionGetCurrentConnectionIDs ( ) : void
return	void

EnableActionGetCurrentConnectionInfo() protected method

Signal that the action GetCurrentConnectionInfo is supported.

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

protected EnableActionGetCurrentConnectionInfo ( ) : void
return	void

EnableActionGetProtocolInfo() protected method

Signal that the action GetProtocolInfo is supported.

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

protected EnableActionGetProtocolInfo ( ) : void
return	void

EnableActionPrepareForConnection() protected method

Signal that the action PrepareForConnection is supported.

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

protected EnableActionPrepareForConnection ( ) : void
return	void

EnablePropertyCurrentConnectionIDs() public method

Enable the CurrentConnectionIDs property.

public EnablePropertyCurrentConnectionIDs ( ) : void
return	void

EnablePropertySinkProtocolInfo() public method

Enable the SinkProtocolInfo property.

public EnablePropertySinkProtocolInfo ( ) : void
return	void

EnablePropertySourceProtocolInfo() public method

Enable the SourceProtocolInfo property.

public EnablePropertySourceProtocolInfo ( ) : void
return	void

GetCurrentConnectionIDs() protected method

GetCurrentConnectionIDs action.

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

protected GetCurrentConnectionIDs ( IDvInvocation aInvocation, string &aConnectionIDs ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aConnectionIDs	string
return	void

GetCurrentConnectionInfo() protected method

GetCurrentConnectionInfo action.

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

protected GetCurrentConnectionInfo ( IDvInvocation aInvocation, int aConnectionID, int &aRcsID, int &aAVTransportID, string &aProtocolInfo, string &aPeerConnectionManager, int &aPeerConnectionID, string &aDirection, string &aStatus ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aConnectionID	int
aRcsID	int
aAVTransportID	int
aProtocolInfo	string
aPeerConnectionManager	string
aPeerConnectionID	int
aDirection	string
aStatus	string
return	void

GetProtocolInfo() protected method

GetProtocolInfo action.

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

protected GetProtocolInfo ( IDvInvocation aInvocation, string &aSource, string &aSink ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aSource	string
aSink	string
return	void

PrepareForConnection() protected method

PrepareForConnection action.

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

protected PrepareForConnection ( IDvInvocation aInvocation, string aRemoteProtocolInfo, string aPeerConnectionManager, int aPeerConnectionID, string aDirection, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void
aInvocation	IDvInvocation	Interface allowing querying of aspects of this particular action invocation.
aRemoteProtocolInfo	string
aPeerConnectionManager	string
aPeerConnectionID	int
aDirection	string
aConnectionID	int
aAVTransportID	int
aRcsID	int
return	void

PropertyCurrentConnectionIDs() public method

Get a copy of the value of the CurrentConnectionIDs property

Can only be called if EnablePropertyCurrentConnectionIDs has previously been called.

public PropertyCurrentConnectionIDs ( ) : string
return	string

PropertySinkProtocolInfo() public method

Get a copy of the value of the SinkProtocolInfo property

Can only be called if EnablePropertySinkProtocolInfo has previously been called.

public PropertySinkProtocolInfo ( ) : string
return	string

PropertySourceProtocolInfo() public method

Get a copy of the value of the SourceProtocolInfo property

Can only be called if EnablePropertySourceProtocolInfo has previously been called.

public PropertySourceProtocolInfo ( ) : string
return	string

SetPropertyCurrentConnectionIDs() public method

Set the value of the CurrentConnectionIDs property

Can only be called if EnablePropertyCurrentConnectionIDs has previously been called.

public SetPropertyCurrentConnectionIDs ( string aValue ) : bool
aValue	string	New value for the property
return	bool

SetPropertySinkProtocolInfo() public method

Set the value of the SinkProtocolInfo property

Can only be called if EnablePropertySinkProtocolInfo has previously been called.

public SetPropertySinkProtocolInfo ( string aValue ) : bool
aValue	string	New value for the property
return	bool

SetPropertySourceProtocolInfo() public method

Set the value of the SourceProtocolInfo property

Can only be called if EnablePropertySourceProtocolInfo has previously been called.

public SetPropertySourceProtocolInfo ( string aValue ) : bool
aValue	string	New value for the property
return	bool