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

Proxy for the upnp.org:ConnectionManager:1 UPnP service
Inheritance: OpenHome.Net.ControlPoint.CpProxy, IDisposable, ICpProxyUpnpOrgConnectionManager1
Show file Open project: openhome/ohNet Class Usage Examples

Public Methods

Method Description
BeginConnectionComplete ( int aConnectionID, 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 EndConnectionComplete().

BeginGetCurrentConnectionIDs ( 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 EndGetCurrentConnectionIDs().

BeginGetCurrentConnectionInfo ( int aConnectionID, 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 EndGetCurrentConnectionInfo().

BeginGetProtocolInfo ( 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 EndGetProtocolInfo().

BeginPrepareForConnection ( String aRemoteProtocolInfo, String aPeerConnectionManager, int aPeerConnectionID, String aDirection, 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 EndPrepareForConnection().

CpProxyUpnpOrgConnectionManager1 ( 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().

EndConnectionComplete ( 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.

EndGetCurrentConnectionIDs ( IntPtr aAsyncHandle, String &aConnectionIDs ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndGetCurrentConnectionInfo ( IntPtr aAsyncHandle, int &aRcsID, int &aAVTransportID, String &aProtocolInfo, String &aPeerConnectionManager, int &aPeerConnectionID, String &aDirection, String &aStatus ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndGetProtocolInfo ( IntPtr aAsyncHandle, String &aSource, String &aSink ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

EndPrepareForConnection ( IntPtr aAsyncHandle, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void

Retrieve the output arguments from an asynchronously invoked action.

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

PropertyCurrentConnectionIDs ( ) : String

Query the value of the CurrentConnectionIDs 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().

PropertySinkProtocolInfo ( ) : String

Query the value of the SinkProtocolInfo 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().

PropertySourceProtocolInfo ( ) : String

Query the value of the SourceProtocolInfo 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().

SetPropertyCurrentConnectionIDsChanged ( System aCurrentConnectionIDsChanged ) : void

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

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

SetPropertySinkProtocolInfoChanged ( System aSinkProtocolInfoChanged ) : void

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

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

SetPropertySourceProtocolInfoChanged ( System aSourceProtocolInfoChanged ) : void

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

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

SyncConnectionComplete ( int aConnectionID ) : void

Invoke the action synchronously

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

SyncGetCurrentConnectionIDs ( String &aConnectionIDs ) : void

Invoke the action synchronously

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

SyncGetCurrentConnectionInfo ( int aConnectionID, int &aRcsID, int &aAVTransportID, String &aProtocolInfo, String &aPeerConnectionManager, int &aPeerConnectionID, String &aDirection, String &aStatus ) : void

Invoke the action synchronously

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

SyncGetProtocolInfo ( String &aSource, String &aSink ) : void

Invoke the action synchronously

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

SyncPrepareForConnection ( String aRemoteProtocolInfo, String aPeerConnectionManager, int aPeerConnectionID, String aDirection, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void

Invoke the action synchronously

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

Private Methods

Method Description
CurrentConnectionIDsPropertyChanged ( ) : void
SinkProtocolInfoPropertyChanged ( ) : void
SourceProtocolInfoPropertyChanged ( ) : void

Method Details

BeginConnectionComplete() 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 EndConnectionComplete().
public BeginConnectionComplete ( int aConnectionID, CallbackAsyncComplete aCallback ) : void
aConnectionID int
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginGetCurrentConnectionIDs() 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 EndGetCurrentConnectionIDs().
public BeginGetCurrentConnectionIDs ( 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

BeginGetCurrentConnectionInfo() 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 EndGetCurrentConnectionInfo().
public BeginGetCurrentConnectionInfo ( int aConnectionID, CallbackAsyncComplete aCallback ) : void
aConnectionID int
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

BeginGetProtocolInfo() 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 EndGetProtocolInfo().
public BeginGetProtocolInfo ( 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

BeginPrepareForConnection() 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 EndPrepareForConnection().
public BeginPrepareForConnection ( String aRemoteProtocolInfo, String aPeerConnectionManager, int aPeerConnectionID, String aDirection, CallbackAsyncComplete aCallback ) : void
aRemoteProtocolInfo String
aPeerConnectionManager String
aPeerConnectionID int
aDirection String
aCallback CallbackAsyncComplete Delegate to run when the action completes. /// This is guaranteed to be run but may indicate an error
return void

CpProxyUpnpOrgConnectionManager1() public method

Constructor
Use CpProxy::[Un]Subscribe() to enable/disable querying of state variable and reporting of their changes.
public CpProxyUpnpOrgConnectionManager1 ( 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

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

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

EndGetCurrentConnectionInfo() 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 EndGetCurrentConnectionInfo ( IntPtr aAsyncHandle, int &aRcsID, int &aAVTransportID, String &aProtocolInfo, String &aPeerConnectionManager, int &aPeerConnectionID, String &aDirection, String &aStatus ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aRcsID int
aAVTransportID int
aProtocolInfo String
aPeerConnectionManager String
aPeerConnectionID int
aDirection String
aStatus String
return void

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

EndPrepareForConnection() 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 EndPrepareForConnection ( IntPtr aAsyncHandle, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void
aAsyncHandle System.IntPtr Argument passed to the delegate set in the above Begin function
aConnectionID int
aAVTransportID int
aRcsID int
return void

PropertyCurrentConnectionIDs() public method

Query the value of the CurrentConnectionIDs 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 PropertyCurrentConnectionIDs ( ) : String
return String

PropertySinkProtocolInfo() public method

Query the value of the SinkProtocolInfo 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 PropertySinkProtocolInfo ( ) : String
return String

PropertySourceProtocolInfo() public method

Query the value of the SourceProtocolInfo 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 PropertySourceProtocolInfo ( ) : String
return String

SetPropertyCurrentConnectionIDsChanged() public method

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

SetPropertySinkProtocolInfoChanged() public method

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

SetPropertySourceProtocolInfoChanged() public method

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

SyncConnectionComplete() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncConnectionComplete ( int aConnectionID ) : void
aConnectionID int
return void

SyncGetCurrentConnectionIDs() public method

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

SyncGetCurrentConnectionInfo() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncGetCurrentConnectionInfo ( int aConnectionID, int &aRcsID, int &aAVTransportID, String &aProtocolInfo, String &aPeerConnectionManager, int &aPeerConnectionID, String &aDirection, String &aStatus ) : void
aConnectionID int
aRcsID int
aAVTransportID int
aProtocolInfo String
aPeerConnectionManager String
aPeerConnectionID int
aDirection String
aStatus String
return void

SyncGetProtocolInfo() public method

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

SyncPrepareForConnection() public method

Invoke the action synchronously
Blocks until the action has been processed on the device and sets any output arguments
public SyncPrepareForConnection ( String aRemoteProtocolInfo, String aPeerConnectionManager, int aPeerConnectionID, String aDirection, int &aConnectionID, int &aAVTransportID, int &aRcsID ) : void
aRemoteProtocolInfo String
aPeerConnectionManager String
aPeerConnectionID int
aDirection String
aConnectionID int
aAVTransportID int
aRcsID int
return void