QXmppStunSocket Class Reference

The QXmppStunSocket class represents an UDP socket capable of performing Interactive Connectivity Establishment (RFC 5245). More...

#include <QXmppStun.h>

List of all members.

Signals

void connected ()
void datagramReceived (const QByteArray &datagram)
void logMessage (QXmppLogger::MessageType type, const QString &msg)
 This signal is emitted to send logging messages.

Public Member Functions

 QXmppStunSocket (bool iceControlling, QObject *parent=0)
QList< QXmppJingleCandidatelocalCandidates () const
QString localUser () const
void setLocalUser (const QString &user)
QString localPassword () const
void setLocalPassword (const QString &password)
int component () const
void setComponent (int component)
bool addRemoteCandidate (const QXmppJingleCandidate &candidate)
 Adds a remote STUN candidate.
void setRemoteUser (const QString &user)
void setRemotePassword (const QString &password)
void close ()
 Closes the socket.
void connectToHost ()
 Start ICE connectivity checks.
bool isConnected () const
 Returns true if ICE negotiation completed, false otherwise.
qint64 writeDatagram (const QByteArray &datagram)

Detailed Description

The QXmppStunSocket class represents an UDP socket capable of performing Interactive Connectivity Establishment (RFC 5245).


Constructor & Destructor Documentation

QXmppStunSocket::QXmppStunSocket ( bool  iceControlling,
QObject *  parent = 0 
)

Constructs a new QXmppStunSocket.


Member Function Documentation

int QXmppStunSocket::component (  )  const

Returns the component id for the current socket, e.g. 1 for RTP and 2 for RTCP.

QList< QXmppJingleCandidate > QXmppStunSocket::localCandidates (  )  const

Returns the list of local HOST CANDIDATES candidates by iterating over the available network interfaces.

void QXmppStunSocket::setComponent ( int  component  ) 

Sets the component id for the current socket, e.g. 1 for RTP and 2 for RTCP.

Parameters:
component 
qint64 QXmppStunSocket::writeDatagram ( const QByteArray &  datagram  ) 

Sends a data packet to the remote party.

Parameters:
datagram 

The documentation for this class was generated from the following files:
 All Classes Functions Enumerations Enumerator

Generated on Sun Aug 22 16:04:14 2010 for QXmpp by  doxygen 1.6.1