~ubuntu-branches/ubuntu/quantal/kdepimlibs/quantal-proposed

« back to all changes in this revision

Viewing changes to kimap/session.h

  • Committer: Package Import Robot
  • Author(s): Philip Muškovac
  • Date: 2011-07-08 00:32:40 UTC
  • mfrom: (1.1.63 upstream)
  • Revision ID: package-import@ubuntu.com-20110708003240-0gzufcu25rui82r1
Tags: 4:4.6.90-0ubuntu1
* New upstream release candidate
  - Bump build-dep on libakonadi-dev
  - update install files with new library versions
  - update libkcal4.install
  - refresh libakonadi-kde4.symbols, libkcalcore4.symbols,
    libkholidays4.symbols and libkimap4.symbols
  - exclude kde-runtime not kdebase-runtime in rules.
  - Update Vcs links for new location

Show diffs side-by-side

added added

removed removed

Lines of Context:
51
51
    quint16 port() const;
52
52
    State state() const;
53
53
 
 
54
    /**
 
55
     * Returns the name that has been set with LoginJob::setUserName()
 
56
     * The user name is useful to uniquely identify an IMAP resource, in combination with the host name
 
57
     * @note If the Session was pre-authenticated, userName() will return an empty string
 
58
     * @since 4.7
 
59
     */
 
60
    QString userName() const;
 
61
 
54
62
    QByteArray serverGreeting() const;
55
63
 
56
64
    /**
85
93
 
86
94
  Q_SIGNALS:
87
95
    void jobQueueSizeChanged( int queueSize );
88
 
    void connectionLost();
 
96
 
 
97
    /**
 
98
      @deprecated
 
99
      Emitted when we loose a previously established connection
 
100
 
 
101
      Likely reasons: server closed the connection, loss of internet connectivity, etc...
 
102
 
 
103
      For historical reasons, this signal is also emitted in the event of a failed connection, but
 
104
      you should not rely on this behavior.
 
105
 
 
106
      New implementations should use connectionFailed() to detect a failure to connect to the host,
 
107
      and stateChanged() to detect a loss of connectivity.
 
108
    */
 
109
    KDE_DEPRECATED void connectionLost();
 
110
 
 
111
    /**
 
112
      Emitted when the Session couldn't connect to the host.
 
113
 
 
114
      Likely reasons: invalid host address, no internet connectivity, firewall blocking rules,
 
115
      etc...
 
116
 
 
117
      Pending jobs in the queue will be deleted, and the first job in the queue will be failed. (ie:
 
118
      it will have its result signal emitted with a non-zero error code.)
 
119
 
 
120
      @since 4.7
 
121
    */
 
122
    void connectionFailed();
 
123
 
 
124
    /**
 
125
      Emitted when the session's state changes.
 
126
 
 
127
      You can use this signal to detect a connection loss (ie: stateChanged is emitted with newState
 
128
      == KIMAP::Session::Disconnected)
 
129
 
 
130
      If you want to receive the stateChanged arguments in your slot, you must register the State
 
131
      enum with @c Q_DECLARE_METATYPE(KIMAP::Session::State) and @c qRegisterMetaType<KIMAP::Session::State>();
 
132
 
 
133
      @since 4.7
 
134
    */
 
135
    void stateChanged(KIMAP::Session::State newState, KIMAP::Session::State oldState);
89
136
 
90
137
  private:
91
138
    Q_PRIVATE_SLOT( d, void doStartNext() )