QXmppJingleCandidate Class
The QXmppJingleCandidate class represents a transport candidate as specified by XEP-0176: Jingle ICE-UDP Transport Method. More...
| Header: | #include <QXmppJingleData.h> |
Public Types
| enum | Type { HostType, PeerReflexiveType, ServerReflexiveType, RelayedType } |
Public Functions
| QXmppJingleCandidate() | |
| QXmppJingleCandidate(const QXmppJingleCandidate &other) | |
| QXmppJingleCandidate(QXmppJingleCandidate &&) | |
| int | component() const |
(since QXmpp 0.9) QString | foundation() const |
(since QXmpp 0.9) int | generation() const |
| QHostAddress | host() const |
| QString | id() const |
| bool | isNull() const |
| int | network() const |
| quint16 | port() const |
| int | priority() const |
| QString | protocol() const |
| void | setComponent(int component) |
(since QXmpp 0.9) void | setFoundation(const QString &foundation) |
(since QXmpp 0.9) void | setGeneration(int generation) |
| void | setHost(const QHostAddress &host) |
| void | setId(const QString &id) |
| void | setNetwork(int network) |
| void | setPort(quint16 port) |
| void | setPriority(int priority) |
| void | setProtocol(const QString &protocol) |
| void | setType(QXmppJingleCandidate::Type type) |
| QXmppJingleCandidate::Type | type() const |
| QXmppJingleCandidate & | operator=(QXmppJingleCandidate &&) |
| QXmppJingleCandidate & | operator=(const QXmppJingleCandidate &other) |
Detailed Description
Member Type Documentation
enum QXmppJingleCandidate::Type
This enum is used to describe a candidate's type.
| Constant | Value | Description |
|---|---|---|
QXmppJingleCandidate::HostType | 0 | Host candidate, a local address/port. |
QXmppJingleCandidate::PeerReflexiveType | 1 | Peer-reflexive candidate, the address/port as seen from the peer. |
QXmppJingleCandidate::ServerReflexiveType | 2 | Server-reflexive candidate, the address/port as seen by the STUN server. |
QXmppJingleCandidate::RelayedType | 3 | Relayed candidate, a candidate from a TURN relay. |
Member Function Documentation
QXmppJingleCandidate::QXmppJingleCandidate()
Constructs an empty candidate.
QXmppJingleCandidate::QXmppJingleCandidate(const QXmppJingleCandidate &other)
Copy-constructor.
QXmppJingleCandidate::QXmppJingleCandidate(QXmppJingleCandidate &&)
Move-constructor.
int QXmppJingleCandidate::component() const
Returns the candidate's component ID.
See also setComponent().
[since QXmpp 0.9] QString QXmppJingleCandidate::foundation() const
Returns the candidate's foundation.
This function was introduced in QXmpp 0.9.
See also setFoundation().
[since QXmpp 0.9] int QXmppJingleCandidate::generation() const
Returns the candidate's generation.
This function was introduced in QXmpp 0.9.
See also setGeneration().
QHostAddress QXmppJingleCandidate::host() const
Returns the candidate's host address.
See also setHost().
QString QXmppJingleCandidate::id() const
Returns the candidate's unique identifier.
See also setId().
bool QXmppJingleCandidate::isNull() const
Returns true if the host address or port are empty.
int QXmppJingleCandidate::network() const
Returns the network index (starting at 0) the candidate is on.
See also setNetwork().
quint16 QXmppJingleCandidate::port() const
Returns the candidate's port number.
See also setPort().
int QXmppJingleCandidate::priority() const
Returns the candidate's priority.
See also setPriority().
QString QXmppJingleCandidate::protocol() const
Returns the candidate's protocol (e.g. "udp").
See also setProtocol().
void QXmppJingleCandidate::setComponent(int component)
Sets the candidates's component ID.
See also component().
[since QXmpp 0.9] void QXmppJingleCandidate::setFoundation(const QString &foundation)
Sets the candidate's foundation.
This function was introduced in QXmpp 0.9.
See also foundation().
[since QXmpp 0.9] void QXmppJingleCandidate::setGeneration(int generation)
Sets the candidate's generation.
This function was introduced in QXmpp 0.9.
See also generation().
void QXmppJingleCandidate::setHost(const QHostAddress &host)
Sets the candidate's host address.
See also host().
void QXmppJingleCandidate::setId(const QString &id)
Sets the candidate's unique identifier.
id.
See also id().
void QXmppJingleCandidate::setNetwork(int network)
Sets the network index (starting at 0) the candidate is on.
See also network().
void QXmppJingleCandidate::setPort(quint16 port)
Sets the candidate's port number.
See also port().
void QXmppJingleCandidate::setPriority(int priority)
Sets the candidate's priority.
See also priority().
void QXmppJingleCandidate::setProtocol(const QString &protocol)
Sets the candidate's protocol (e.g. "udp").
See also protocol().
void QXmppJingleCandidate::setType(QXmppJingleCandidate::Type type)
Sets the candidate type (e.g. "host").
See also type().
QXmppJingleCandidate::Type QXmppJingleCandidate::type() const
Returns the candidate type (e.g. "host").
See also setType().
QXmppJingleCandidate &QXmppJingleCandidate::operator=(QXmppJingleCandidate &&)
Move-assignment operator.
QXmppJingleCandidate &QXmppJingleCandidate::operator=(const QXmppJingleCandidate &other)
Assignment operator.