doc/xfer-signals.dox

Sat, 25 Nov 2017 21:42:28 +0800

author
Tom Li <tomli@tomli.me>
date
Sat, 25 Nov 2017 21:42:28 +0800
branch
release-2.x.y
changeset 38792
fdb68b9b02b8
parent 20897
2608e9e07913
permissions
-rw-r--r--

jabber.c: fix #17270, ignore STARTTLS when using BOSH.

Pidgin wants to establish a TLS connection with a STARTTLS request, but
it doesn't make any sense, since the XMPP stream is proxied by the BOSH
connection, which is already encrypted by HTTPS. It is impossible to
STARTTLS with BOSH.

According to XEP-0206: The client SHOULD ignore any Transport Layer Security
(TLS) feature since BOSH channel encryption SHOULD be negotiated at the HTTP
layer.

Failing to do it causes Pidgin fails to create any connection with BOSH to any
XMPP server with STARTTLS enabled.

https://developer.pidgin.im/ticket/17270

11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
1 /** @page xfer-signals File Transfer Signals
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
2
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
3 @signals
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
4 @signal file-recv-accept
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
5 @signal file-recv-start
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
6 @signal file-recv-cancel
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
7 @signal file-recv-complete
13220
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
8 @signal file-recv-request
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
9 @signal file-send-accept
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
10 @signal file-send-start
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
11 @signal file-send-cancel
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
12 @signal file-send-complete
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
13 @endsignals
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
14
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
15 @see ft.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
16
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
17 <hr>
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
18
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
19 @signaldef file-recv-accept
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
20 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
21 void (*file_recv_accept)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
22 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
23 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
24 Emitted when an incoming file transfer has been accepted.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
25 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
26 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
27 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
28
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
29 @signaldef file-recv-start
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
30 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
31 void (*file_recv_start)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
32 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
33 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
34 Emitted when an incoming file transfer has been started.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
35 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
36 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
37 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
38
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
39 @signaldef file-recv-cancel
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
40 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
41 void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
42 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
43 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
44 Emitted when an incoming file transfer has been canceled.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
45 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
46 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
47 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
48
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
49 @signaldef file-recv-complete
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
50 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
51 void (*file_recv_complete)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
52 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
53 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
54 Emitted when an incoming file transfer has been completed.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
55 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
56 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
57 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
58
13220
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
59 @signaldef file-recv-request
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
60 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
61 void (*file_recv_request)(PurpleXfer *xfer, gpointer data);
13220
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
62 @endsignalproto
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
63 @signaldesc
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
64 Emitted before the user is prompted for an incoming file-transfer.
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
65 Plugins can intercept the signal to auto-accept/auto-reject the
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
66 requests. To auto-accept the file transfer, use
16257
66f737e6b718 More renaming.
Richard Laager <rlaager@pidgin.im>
parents: 16244
diff changeset
67 purple_xfer_request_accepted(). To auto-reject, set the status of the
66f737e6b718 More renaming.
Richard Laager <rlaager@pidgin.im>
parents: 16244
diff changeset
68 xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL.
13220
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
69 @param xfer The file transfer
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
70 @param data User data
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
71 @endsignaldef
4eca54b95034 [gaim-migrate @ 15583]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11281
diff changeset
72
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
73 @signaldef file-send-accept
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
74 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
75 void (*file_send_accept)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
76 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
77 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
78 Emitted when an outgoing file transfer has been accepted.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
79 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
80 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
81 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
82
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
83 @signaldef file-send-start
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
84 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
85 void (*file_send_start)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
86 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
87 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
88 Emitted when an outgoing file transfer has started.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
89 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
90 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
91 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
92
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
93 @signaldef file-send-cancel
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
94 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
95 void (*file_send_cancel)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
96 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
97 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
98 Emitted when an outgoing file transfer has been canceled.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
99 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
100 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
101 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
102
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
103 @signaldef file-send-complete
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
104 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13220
diff changeset
105 void (*file_send_complete)(PurpleXfer *xfer, gpointer data);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
106 @endsignalproto
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
107 @signaldesc
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
108 Emitted when an outgoing file transfer has been completed.
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
109 @param xfer The file transfer
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
110 @param data User data
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
111 @endsignaldef
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
112
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
113 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
114 // vim: syntax=c.doxygen tw=75 et

mercurial