1
0
mirror of https://github.com/tomahawk-player/tomahawk.git synced 2025-07-31 11:20:22 +02:00

Change comment style to gobal default

This commit is contained in:
Uwe L. Korn
2013-04-09 17:27:00 +02:00
parent 5ea9bbe604
commit 20d3f1ad72
6 changed files with 81 additions and 22 deletions

View File

@@ -36,11 +36,19 @@ class ACCOUNTDLLEXPORT TomahawkXmppMessage : public Jreen::Payload
TomahawkXmppMessage(const QList<SipInfo>& sipInfo); TomahawkXmppMessage(const QList<SipInfo>& sipInfo);
~TomahawkXmppMessage(); ~TomahawkXmppMessage();
//! The SipInfo objects that are wrapped in this XmppMessage /**
* The SipInfo objects that are wrapped in this XmppMessage
*/
const QList<SipInfo> sipInfo() const; const QList<SipInfo> sipInfo() const;
//! The name of the peer contained in this message
/**
* The name of the peer contained in this message
*/
const QString key() const; const QString key() const;
//! The name of the peer contained in this message
/**
* The name of the peer contained in this message
*/
const QString uniqname() const; const QString uniqname() const;
private: private:

View File

@@ -43,13 +43,24 @@ private:
enum State { AtNowhere, AtTransport, AtCandidate } m_state; enum State { AtNowhere, AtTransport, AtCandidate } m_state;
//! All the provided Sip informations /**
* All the provided Sip informations
*/
QList<SipInfo> m_sipInfo; QList<SipInfo> m_sipInfo;
//! The current parsing depth
/**
* The current parsing depth
*/
int m_depth; int m_depth;
//! The unique name of the peer
/**
* The unique name of the peer
*/
QString m_uniqname; QString m_uniqname;
//! The authentication key of the peer
/**
* The authentication key of the peer
*/
QString m_key; QString m_key;
}; };

View File

@@ -57,9 +57,14 @@ public:
bool _disowned; bool _disowned;
msg_ptr _msg; msg_ptr _msg;
//! Set a time limit for establishing a connection. /**
* Set a time limit for establishing a connection.
*/
void setConnectTimeout( qint32 timeout ) { m_connectTimeout = timeout; } void setConnectTimeout( qint32 timeout ) { m_connectTimeout = timeout; }
//! Get the current timeout for establishing a connection.
/**
* Get the current timeout for establishing a connection.
*/
qint32 connectTimeout() const { return m_connectTimeout; } qint32 connectTimeout() const { return m_connectTimeout; }
private slots: private slots:
@@ -73,9 +78,14 @@ private slots:
this->disconnectFromHost(); this->disconnectFromHost();
} }
private: private:
//! How long we will wait for a connection to establish /**
* How long we will wait for a connection to establish
*/
qint32 m_connectTimeout; qint32 m_connectTimeout;
//! Timer to measure the connection initialisation
/**
* Timer to measure the connection initialisation
*/
QTimer* m_connectTimer; QTimer* m_connectTimer;
}; };

View File

@@ -94,13 +94,25 @@ public:
void reverseOfferRequest( ControlConnection* orig_conn, const QString &theirdbid, const QString& key, const QString& theirkey ); void reverseOfferRequest( ControlConnection* orig_conn, const QString &theirdbid, const QString& key, const QString& theirkey );
bool visibleExternally() const { return (!m_externalHostname.isNull()) || (m_externalAddresses.length() > 0); } bool visibleExternally() const { return (!m_externalHostname.isNull()) || (m_externalAddresses.length() > 0); }
//! The port this Peer listens directly (per default)
/**
* The port this Peer listens directly (per default)
*/
int port() const { return m_port; } int port() const { return m_port; }
//! The IP addresses this Peer listens directly (per default)
/**
* The IP addresses this Peer listens directly (per default)
*/
QList< QHostAddress > addresses() const { return m_externalAddresses; } QList< QHostAddress > addresses() const { return m_externalAddresses; }
//! An additional address this peer listens to, e.g. via UPnP.
/**
* An additional address this peer listens to, e.g. via UPnP.
*/
QString additionalAddress() const { return m_externalHostname; } QString additionalAddress() const { return m_externalHostname; }
//! An additional port this peer listens to, e.g. via UPnP (only in combination with additionalAddress.
/**
* An additional port this peer listens to, e.g. via UPnP (only in combination with additionalAddress.
*/
int additionalPort() const { return m_externalPort; } int additionalPort() const { return m_externalPort; }
static bool isIPWhitelisted( QHostAddress ip ); static bool isIPWhitelisted( QHostAddress ip );
@@ -155,13 +167,24 @@ private:
QMap< QString, QPointer< Connection > > m_offers; QMap< QString, QPointer< Connection > > m_offers;
QStringList m_connectedNodes; QStringList m_connectedNodes;
//! The external port used by all address except those obtained via UPnP or the static configuration option /**
* The external port used by all address except those obtained via UPnP or the static configuration option
*/
int m_port; int m_port;
//! Either the static set or the UPnP set external port
/**
* Either the static set or the UPnP set external port
*/
int m_externalPort; int m_externalPort;
//! All available external IPs
/**
* All available external IPs
*/
QList<QHostAddress> m_externalAddresses; QList<QHostAddress> m_externalAddresses;
//! Either the static set or the UPnP set external host
/**
* Either the static set or the UPnP set external host
*/
QString m_externalHostname; QString m_externalHostname;
bool m_ready; bool m_ready;

View File

@@ -112,10 +112,14 @@ public:
void setData( const QVariant& data ); void setData( const QVariant& data );
const QVariant data() const; const QVariant data() const;
//! Get the node id of this peer /**
* Get the node id of this peer
*/
const QString nodeId() const; const QString nodeId() const;
//! Get the authentication key for this host /**
* Get the authentication key for this host
*/
const QString key() const; const QString key() const;
signals: signals:

View File

@@ -70,7 +70,10 @@ public slots:
virtual void configurationChanged() = 0; virtual void configurationChanged() = 0;
virtual void addContact( const QString& peerId, const QString& msg = QString() ) = 0; virtual void addContact( const QString& peerId, const QString& msg = QString() ) = 0;
//! Send a list of SipInfos to all contacts.
/**
* Send a list of SipInfos to all contacts.
*/
virtual void sendSipInfo( const Tomahawk::peerinfo_ptr& receiver, const QList<SipInfo>& info ) = 0; virtual void sendSipInfo( const Tomahawk::peerinfo_ptr& receiver, const QList<SipInfo>& info ) = 0;
signals: signals: