source: trunk/libtransmission/handshake.h @ 8561

Last change on this file since 8561 was 8561, checked in by charles, 13 years ago

(trunk libT) re-start work on making libT doxygen friendly. still a long ways to go on this.

  • Property svn:keywords set to Date Rev Author Id
File size: 1.9 KB
Line 
1/*
2 * This file Copyright (C) 2007-2009 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: handshake.h 8561 2009-05-29 19:17:12Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_HANDSHAKE_H
18#define TR_HANDSHAKE_H
19
20#include "transmission.h"
21#include "net.h"
22
23/** @addtogroup peers Peers
24    @{ */
25
26struct tr_peerIo;
27
28/** @brief opaque struct holding hanshake state information.
29           freed when the handshake is completed. */
30typedef struct tr_handshake tr_handshake;
31
32/* returns true on success, false on error */
33typedef tr_bool ( *handshakeDoneCB )( struct tr_handshake * handshake,
34                                      struct tr_peerIo *    io,
35                                      tr_bool               isConnected,
36                                      const uint8_t *       peerId,
37                                      void *                userData );
38
39/** @brief instantiate a new handshake */
40tr_handshake *         tr_handshakeNew( struct tr_peerIo * io,
41                                        tr_encryption_mode encryptionMode,
42                                        handshakeDoneCB    doneCB,
43                                        void *             doneUserData );
44
45const tr_address *     tr_handshakeGetAddr( const struct tr_handshake  * handshake,
46                                            tr_port                    * port );
47
48void                   tr_handshakeAbort( tr_handshake * handshake );
49
50struct tr_peerIo*      tr_handshakeGetIO( tr_handshake * handshake );
51
52struct tr_peerIo*      tr_handshakeStealIO( tr_handshake * handshake );
53
54
55/** @} */
56#endif
Note: See TracBrowser for help on using the repository browser.