BrisaUpnp::BrisaControlPoint Class Reference

Class that implements the control part in UPnP Architecture. More...

#include <BrisaUpnp/BrisaControlPoint>

List of all members.

Signals

void deviceFound (BrisaControlPointDevice *device)
void deviceGone (QString udn)
void multicastReceived (QString variableName, QString newValue)
void multicastReceivedRaw (BrisaOutArgument raw)

Public Member Functions

 BrisaControlPoint (QObject *parent=0, QString st="ssdp:all", int mx=5)
 ~BrisaControlPoint ()
void start ()
void stop ()
bool isRunning ()
void discover ()
BrisaEventProxygetSubscriptionProxy (BrisaControlPointService *service)

Detailed Description

Class that implements the control part in UPnP Architecture.

Create a ControlPoint and start(), then discover() devices will be found in network. If you don't want to look for more devices then use stop().

Definition at line 55 of file brisacontrolpoint.h.


Constructor & Destructor Documentation

BrisaControlPoint::BrisaControlPoint ( QObject *  parent = 0,
QString  st = "ssdp:all",
int  mx = 5 
)

Constructor

Parameters:
parent parent
st service type
mx interval

Definition at line 39 of file brisacontrolpoint.cpp.

BrisaControlPoint::~BrisaControlPoint (  ) 

Destructor

Definition at line 78 of file brisacontrolpoint.cpp.


Member Function Documentation

void BrisaUpnp::BrisaControlPoint::deviceFound ( BrisaControlPointDevice device  )  [signal]

This signal is emitted when a new device is find in network and all it's attributes are created by the xml reading.

See also:
deviceGone(QString udn)
Parameters:
device the device that has been found

Definition at line 109 of file moc_brisacontrolpoint.cpp.

void BrisaUpnp::BrisaControlPoint::deviceGone ( QString  udn  )  [signal]

This signal is emitted when a device leaves the network, that means that the the ssdp client received a "ssdp:byebye" message from the device and, to handle this, the control point emit a deviceGone event with the device's udn as parameter.

See also:
deviceFound(BrisaControlPointDevice *device)

Definition at line 116 of file moc_brisacontrolpoint.cpp.

void BrisaControlPoint::discover (  ) 

Starts the control point msearch discover.

Definition at line 114 of file brisacontrolpoint.cpp.

BrisaEventProxy * BrisaControlPoint::getSubscriptionProxy ( BrisaControlPointService service  ) 

Gets an event proxy to subscribe, usubscribe or renew the events from a service.

Parameters:
service empty

Definition at line 170 of file brisacontrolpoint.cpp.

bool BrisaControlPoint::isRunning (  ) 

Return if the control point is running

Returns:
true if the control point is running or false otherwise
See also:
start(), stop()

Definition at line 110 of file brisacontrolpoint.cpp.

void BrisaUpnp::BrisaControlPoint::multicastReceived ( QString  variableName,
QString  newValue 
) [signal]

Signal emitted when a multicast message is received.

Parameters:
variableName name of the state variable.
newValue new value of the state variable.

Definition at line 123 of file moc_brisacontrolpoint.cpp.

void BrisaUpnp::BrisaControlPoint::multicastReceivedRaw ( BrisaOutArgument  raw  )  [signal]

Signal emitted when a multicast message is received.

Similar to multicastReceived, but sends a BrisaOutArgument containing all the attributes of the multicast event massage, including "variableName" and "newValue".

Parameters:
raw attributes of the multicast event message.

Definition at line 130 of file moc_brisacontrolpoint.cpp.

void BrisaControlPoint::start (  ) 

Starts the control point, the ssdpClient and the msearch

See also:
stop(), isRunning()

Definition at line 90 of file brisacontrolpoint.cpp.

void BrisaControlPoint::stop (  ) 

Stops the control point, the ssdpClient and the msearch

See also:
start(), isRunning()

Definition at line 100 of file brisacontrolpoint.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 30 14:04:30 2010 for Brisa by  doxygen 1.6.3