IConnectionManager

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This pure virtual class contains methods that expose the functionality provided by the UPnP AV ConnectionManager service. The ConnectionManager service manages media transport sessions on both MediaRenderer and MediaServer devices.

Syntax

IConnectionManager : public IEventSource

Methods

The following table shows the methods for this class. This class also inherits the methods from the IEventSource class.

Method	Description
IConnectionManager::ConnectionComplete	Enables devices to clean up connections.
IConnectionManager::GetCurrentConnectionInfo	Returns information about the specified connection.
IConnectionManager::GetFirstConnectionID	Starts an iteration through the connection IDs for connections managed by this ConnectionManager instance, and returns the first connection ID.
IConnectionManager::GetNextConnectionID	Returns a connection ID for a connection managed by this ConnectionManager instance, and moves to the next connection ID.
IConnectionManager::GetProtocolInfo	Returns the protocol information, including network and content format data, supported by this ConnectionManager instance.
IConnectionManager::InvokeVendorAction	Enables ConnectionManager implementations and users to provide and invoke custom vendor-specific actions that are not defined in the ConnectionManager DCP.
IConnectionManager::PrepareForConnection	Enables devices to prepare for an upcoming media transfer.

Obtaining a Pointer

This class is used by UPnP AV devices and control points.

UPnP AV devices implement the methods in this class to make their device hardware and other functionality available to UPnP control points.

Rather than deriving directly from this class, devices can inherit from the provided IConnectionManagerImpl class, which provides useful implementations for the methods in this class. In contrast to the other similar implementation classes (like IAVTransportImpl, and so on), IConnectionManagerImpl provides more than method overrides for optional methods. IConnectionManagerImpl includes a connection and protocol management implementation that most devices can use; therefore, these devices do not have to provide their own connection and protocol management code. Or, as always, code can inherit directly from IConnectionManager and provide a completely custom implementation of the methods in this class.

Note

To keep the same organization as the other pure virtual classes, like IAVTransport, the documentation for the methods in this interface includes information about method implementations provided by IConnectionManagerImpl. For more information about additional methods defined only on IConnectionManagerImpl, like IConnectionManagerImpl::AddSinkProtocol, see IConnectionManagerImpl.

Control points use this class to control UPnP AV devices. A control point obtains a pointer to this class by calling MediaRendererDevice::GetConnectionManager or MediaServerDevice::GetConnectionManager.

Remarks

The methods in this class match the actions in the ConnectionManager service, with the exception of IConnectionManager::InvokeVendorAction, IConnectionManager::GetFirstConnectionID and IConnectionManager::GetNextConnectionID (the latter two replace the single GetCurrentConnectionIDs action).

For more information about the ConnectionManager service, see UPnP AV DCP Documentation.

Requirements

Header	av_upnp.h
Library	Av_upnp.lib
Windows Embedded CE	Windows CE 5.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

UPnP AV Interface and Implementation Classes
IAVTransport
IAVTransportImpl
IConnectionManagerImpl
IConnectionManagerImpl::AddSinkProtocol
IEventSource
MediaRendererDevice::GetConnectionManager
MediaServerDevice::GetConnectionManager