3 * Copyright (c) 2007 - 2010, Blue Static <http://www.bluestatic.org>
5 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
6 * General Public License as published by the Free Software Foundation; either version 2 of the
7 * License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
10 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License along with this program; if not,
14 * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
17 #import <Cocoa/Cocoa.h>
19 @protocol DebuggerConnectionDelegate
;
20 @
class LoggingController
;
22 // This class is the lowest level component to the network. It deals with all
23 // the intricacies of network and stream programming. Almost all the work this
24 // class does is on a background thread, which is created when the connection is
25 // asked to connect and shutdown when asked to close.
26 @interface DebuggerConnection
: NSObject
28 // The port to connect on.
31 // If the connection to the debugger engine is currently active.
34 // The thread on which network operations are performed. Weak.
37 // Reference to the message loop that the socket runs on. Weak.
40 // The raw CFSocket on which the two streams are based. Strong.
43 // The read stream that is scheduled on the main run loop. Weak.
44 CFReadStreamRef readStream_
;
46 // The write stream. Weak.
47 CFWriteStreamRef writeStream_
;
49 // An ever-increasing integer that gives each transaction a unique ID for the
51 NSUInteger transactionID
;
53 // The most recently received transaction ID.
54 NSUInteger lastReadTransaction_
;
56 // The last transactionID written to the stream.
57 NSUInteger lastWrittenTransaction_
;
59 // To prevent blocked writing, we enqueue all writes and then wait for the
60 // write stream to tell us it's ready. We store the pending commands in this
61 // array. We use this as a queue (FIFO), with index 0 being first.
62 NSMutableArray
* queuedWrites_
;
64 // We send queued writes in multiple places, sometimes off a run loop event.
65 // Because of this, we need to ensure that only one client is dequeing and
67 NSRecursiveLock
* writeQueueLock_
;
69 // Information about the current read loop. We append to |currentPacket_|
70 // until |currentPacketSize_| has reached |packetSize_|.
71 NSMutableString
* currentPacket_
;
73 int currentPacketIndex_
;
75 // The delegate. All methods are executed on the main thread.
76 NSObject
<DebuggerConnectionDelegate
>* delegate_
;
79 @
property (readonly
) NSUInteger port
;
80 @
property (readonly
) BOOL connected
;
81 @
property (assign
) id
<DebuggerConnectionDelegate
> delegate
;
83 - (id
)initWithPort
:(NSUInteger
)aPort
;
88 - (void)send
:(NSString
*)command
;
90 // This sends the given command format to the debugger. This method is thread
91 // safe and schedules the request on the |runLoop_|.
92 - (NSNumber
*)sendCommandWithFormat
:(NSString
*)format
, ...;
94 - (NSString
*)escapedURIPath
:(NSString
*)path
;
95 - (NSInteger
)transactionIDFromResponse
:(NSXMLDocument
*)response
;
96 - (NSInteger
)transactionIDFromCommand
:(NSString
*)command
;
100 // Delegate ////////////////////////////////////////////////////////////////////
102 @protocol DebuggerConnectionDelegate
<NSObject
>
106 - (void)connectionDidAccept
:(DebuggerConnection
*)cx
;
107 - (void)connectionDidClose
:(DebuggerConnection
*)cx
;
109 - (void)handleInitialResponse
:(NSXMLDocument
*)response
;
111 - (void)handleResponse
:(NSXMLDocument
*)response
;
113 - (void)errorEncountered
:(NSString
*)error
;