Changeset 7357


Ignore:
Timestamp:
Dec 11, 2008, 5:02:34 PM (12 years ago)
Author:
charles
Message:

(libT) add some documentation about the three separate peer structs and how they are related.

Location:
trunk/libtransmission
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/peer-common.h

    r7238 r7357  
    2323
    2424#include "transmission.h"
    25 #include "publish.h"
    2625
    2726typedef enum
  • trunk/libtransmission/peer-mgr-private.h

    r7353 r7357  
    3838};
    3939
     40/**
     41 * State information about a connected peer.
     42 *
     43 * @see struct peer_atom
     44 * @see tr_peermsgs
     45 */
    4046typedef struct tr_peer
    4147{
  • trunk/libtransmission/peer-mgr.c

    r7353 r7357  
    9797};
    9898
    99 /* We keep one of these for every peer we know about, whether
    100  * it's connected or not, so the struct must be small.
    101  * When our current connections underperform, we dip back
    102  * into this list for new ones. */
     99/**
     100 * Peer information that should be kept even before we've connected and
     101 * after we've disconnected.  These are kept in a pool of peer_atoms to decide
     102 * which ones would make good candidates for connecting to, and to watch out
     103 * for banned peers.
     104 *
     105 * @see tr_peer
     106 * @see tr_peermsgs
     107 */
    103108struct peer_atom
    104109{
  • trunk/libtransmission/peer-msgs.c

    r7353 r7357  
    258258};
    259259
     260/**
     261 * Low-level communication state information about a connected peer.
     262 *
     263 * This structure remembers the low-level protocol states that we're
     264 * in with this peer, such as active requests, pex messages, and so on.
     265 * Its fields are all private to peer-msgs.c.
     266 *
     267 * Data not directly involved with sending & receiving messages is
     268 * stored in tr_peer, where it can be accessed by both peermsgs and
     269 * the peer manager.
     270 *
     271 * @see struct peer_atom
     272 * @see tr_peer
     273 */
    260274struct tr_peermsgs
    261275{
  • trunk/libtransmission/webseed.h

    r7151 r7357  
    2121
    2222#include "peer-common.h"
     23#include "publish.h"
    2324
    2425tr_webseed* tr_webseedNew( struct tr_torrent * torrent,
Note: See TracChangeset for help on using the changeset viewer.