BLIP/BLIPConnection.h
changeset 9 980beba83fb7
parent 3 76f302097a75
child 18 3be241de1630
     1.1 --- a/BLIP/BLIPConnection.h	Sat May 24 21:26:09 2008 -0700
     1.2 +++ b/BLIP/BLIPConnection.h	Fri May 30 13:54:38 2008 -0700
     1.3 @@ -12,7 +12,7 @@
     1.4  @protocol BLIPConnectionDelegate;
     1.5  
     1.6  
     1.7 -/** Represents a connection to a peer, using the BLIP protocol over a TCP socket.
     1.8 +/** Represents a connection to a peer, using the <a href=".#blipdesc">BLIP</a> protocol over a TCP socket.
     1.9      Outgoing connections are made simply by instantiating a BLIPConnection via -initToAddress:.
    1.10      Incoming connections are usually set up by a BLIPListener and passed to the listener's
    1.11      delegate.
    1.12 @@ -34,14 +34,14 @@
    1.13      a generic error response will be returned. */
    1.14  @property (readonly) BLIPDispatcher *dispatcher;
    1.15  
    1.16 -/** Creates an outgoing request, with no properties.
    1.17 -    The body may be nil.
    1.18 -    To send it, call -send. */
    1.19 -- (BLIPRequest*) requestWithBody: (NSData*)body;
    1.20 +/** Creates a new, empty outgoing request.
    1.21 +    You should add properties and/or body data to the request, before sending it by
    1.22 +    calling its -send method. */
    1.23 +- (BLIPRequest*) request;
    1.24  
    1.25 -/** Creates an outgoing request.
    1.26 -    The body or properties may be nil.
    1.27 -    To send it, call -send. */
    1.28 +/** Creates a new outgoing request.
    1.29 +    The body or properties may be nil; you can add additional data or properties by calling
    1.30 +    methods on the request itself, before sending it by calling its -send method. */
    1.31  - (BLIPRequest*) requestWithBody: (NSData*)body
    1.32                        properties: (NSDictionary*)properies;
    1.33  
    1.34 @@ -78,7 +78,7 @@
    1.35  
    1.36  
    1.37  
    1.38 -/** A "server" that listens on a TCP socket for incoming BLIP connections and creates
    1.39 +/** A "server" that listens on a TCP socket for incoming <a href=".#blipdesc">BLIP</a> connections and creates
    1.40      BLIPConnection instances to handle them.
    1.41      Most of the API is inherited from TCPListener. */
    1.42  @interface BLIPListener : TCPListener